Operation: reporting::reportGetPreviewData


General Description

Return preview data from report query.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
sys.f.manageReports -- -- db.[default_db].h_sys_reports.browse

Request Message

Input Parameters

The reportGetPreviewData method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType optional
default=com.hornbill.core
The name of the application where this report definition belongs.
reportId xs:unsignedInt optional The identifier of the report to retrieve preview data for
definition reportDefinitionType optional Definition of the report
runtimeParameter reportRuntimeParametersType optional Runtime parameter(s) needed by the report to run
formatValues xs:boolean optional
default=false
This is an optional parameter, the default value is 'false'. If you do not specify this parameter or specify false, the result set will be returned with the data values in their raw format. If you specify true, then the values will be formatted according to the application level format settings.
returnMeta xs:boolean optional
default=false
This is an optional parameter, the default value is 'false'. If you do not specify this parameter or specify false, the result set will be returned but will not include any meta data. If you specify true, then the meta data that describes the result set will be returned.
returnRawValues xs:boolean optional
default=false
This is an optional parameter, the default value is 'false'. If you specify true, then the result data will include raw values for columns that have been formatted. The raw values are returned as an attribute in the corresponding column value called "raw". The raw value will only be present if: -

- The value has been formatted and is now different to the raw value
- The column is not a TEXT or BLOB data type.
maxResults maxResultsType optional
default=500
This is an optional parameter, the default value is 500. Specify the value to limit the results returned from your report query

Input Data


Response Message

Output Parameters

Name Type Attributes Description
reportOutputData reportOutputData optional preview data of report

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by Esp.demo.ServerService, 8.0.0.3162.)