Page History
...
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The HTML request will return an HTML representation of the report. The HTML document will be stored in the BinaryData parameter, as Base64 encoded data. The report's charts and/or images will be stored in an array of Chart parameters. These artefacts will need to be manually decoded by the client system, and the URL request string is used to embed the URL within the HTML for decoding the Base64 images.
Request ElementsThe following elements will be passed with this request:
Request ExampleThe following SOAP example shows the parameters that you can pass to this call:
Response ElementsThe response will contain these main parameters:
Response ExampleThe service will return the below response, according to our SOAP example:
InstructionsSee below for step-by-step instructions on how to perform this call, using a Java example:
Complete ExampleBelow is a full example of this function. To use it for yourself, carry out the following the steps:
|
anchor
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
The PDF request runs a specified report and returns it in PDF form. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
...
...
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
The CSV request runs a specified report and returns it in CSV form. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
...
Expand | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
The TEXT request runs a specified report and returns it in TEXT form. The following code will accomplish this:
The returned ReportServiceResponse object consists of:
|
...
title | RTF |
---|
The RTF request runs a specified report and returns it in RTF form. The following code will accomplish this:
Code Block |
---|
ReportServiceRequest rsr = new ReportServiceRequest();
ReportServiceResponse rs = null;
rsr.setLoginId(this.username);
rsr.setPassword(this.password);
// This is the primary organization
rsr.setOrgId(new Integer(1));
rsr.setReportRequest("RTF");
rsr.setReportId(12345);
rs = ReportService.remoteReportCall(rsr);
|
The returned ReportServiceResponse object consists of:
...
Response Element
...
Data Type
...
Description
...
Retrieval Code
...
ReportId
...
Integer
...
ID of the specified report
...
getReportId()
...
ReportName
...
String
...
Name of the specified report
...
getReportName()
...
HitCount
...
Integer
...
Number of times the specified report has been accessed
...
getHitCount()
...
FormatCode
...
String
...
Format code of the specified report
...
getFormatCode()
...
BinaryData
...
String
...
Base64 encoded binary chunk of XLS
...
getBinaryData()
...
ContentType
...
String
...
MIME Content Type of this object. Value will be “application/rtf”
...