|
Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > ReportEditingService Service >
applyReportParams() Method
The applyReportParams() method applies report arguments to the report and returns the results. Signature
Object applyReportParams(ReportRef object, ReportParams reportParams, boolean encodeInString, String sessionID);
|
|
ReportRef object |
The path to the report definition, supplied in the ReportRef common structure. For information about the ReportRef structure, read ReportRef Structure. |
ReportParams reportParams |
Optional. The filters or variables to apply to the report before execution, supplied in the ReportParams common structure. For more information, read Description of Siebel Analytics Web SOAP API Methods. |
boolean encodeInString |
A boolean value, 1 (true) or 0 (false). When set to true, the returned report object is encoded as a character string. |
String sessionID |
A character string that identifies the session ID. The session ID is usually returned by the logon call. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
Returns
Returns the result of applying report arguments to the specified report object. If you set encodeInString to true, then the result is encoded as a character string.
|
