Report samples
Methods
getReports
Description:
Method | Return values | Description |
---|---|---|
getReports(boolean active) |
List<Report> |
Returns a list of reports. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/openkm";
String username = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
try
{
ws.login(user, password);
List<Report> reports = ws.getReports(true);
foreach (Report rep in reports)
{
System.Console.WriteLine(rep.toString());
}
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
getReport
Description:
Method | Return values | Description |
---|---|---|
getReport(long rpId) |
Report |
Returns reports. |
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.bean;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/openkm";
String username = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
try
{
ws.login(user, password);
List<Report> reports = ws.getReports(true);
Report report = new Report();
foreach (var rep in reports)
{
if (rep.fileName.Equals("DocumentCheckout.rep"))
{
// Get report
report = ws.getReport(rep.id);
break;
}
}
System.Console.WriteLine(report.toString());
}
catch (Exception e)
{
System.Console.WriteLine(e.ToString());
}
}
}
}
executeReport
Description:
Method | Return values | Description |
---|---|---|
executeReport(long rpId, Dictionary<String, String> params, String format) |
Stream |
Return a document result of executing a report. |
Avaialble formats:
|
Example:
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
using com.openkm.sdk4csharp;
using com.openkm.sdk4csharp.util;
namespace OKMRest
{
public class Program
{
static void Main(string[] args)
{
String host = "http://localhost:8080/openkm";
String username = "okmAdmin";
String password = "admin";
OKMWebservice ws = OKMWebservicesFactory.newInstance(host);
try
{
ws.login(user, password);
List<Report> reports = ws.getReports(true);
Report report = new Report();
foreach (var rep in reports)
{
if (rep.fileName.Equals("DocumentCheckout.rep"))
{
// Get report
report = ws.getReport(rep.id);
break;
}
}
Dictionary<String, String> param = new Dictionary<String, String>();
param.Add("from_date", "2016-01-01");
param.Add("to_date", "2016-12-23");
Stream stream = ws.executeReport(report.id, Report.FORMAT_PDF, param);
BeanHelper beanHelper = new BeanHelper();
Byte[] data = beanHelper.ReadToEnd(stream);
FileStream fileStream = new FileStream(@"C:\Desktop\out.pdf", FileMode.OpenOrCreate, FileAccess.ReadWrite);
foreach (byte b in data)
{
fileStream.WriteByte(b);
}
fileStream.Close();
} catch (Exception e) {
System.Console.WriteLine(e.ToString());
}
}
}
}