Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > XMLViewService Service >

getResults() Method


The getResults() method returns the report results, in XML format.

Signature

Object getResults(ReportRef report, String outputFormat, boolean encodeInString, ReportParams reportParams, String sessionID);

Arguments
Description

ReportRef report

The report definition, supplied in the ReportRef common structure.

For more information, read ReportRef Structure.

String outputFormat

A character string that identifies the output format of the returned report object. Valid values are:

  • "urn: SAWRowset.data"
    This value returns rows without metadata.
  • "urn: SAWRowset.schema"
    This value returns metadata only.
  • "urn: SAWRowset.both"
    This value returns both rows and metadata.

boolean encodeInString

A boolean value, 1 (true) or 0 (false). When set to true (the usual value), it indicates that the returned report object is encoded as a character string.

ReportParams reportParams

Optional. The filters or variables to apply to the report before execution, supplied in the ReportParams common structure. For information about the ReportParams structure, read ReportParams Structure.

String sessionID

A character string that contains 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 XML results for the specified report definition.

Siebel Analytics Web Services Guide