Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Methods in the Siebel Analytics Web SOAP API >

Getting the Results of a Report Using the getResults() Method in the Siebel Analytics Web SOAP API


The getResults method in the XmlViewService service returns the report results, in XML format.

Description of Parameters in the getResults Method()

The getResults() method parameters are described in the following table.

Parameter
Description

ReportRef report

The report definition, supplied in the ReportRef common structure.

For more information, see Referencing a Report Using the ReportRef Structure in the Siebel Analytics Web SOAP API.

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

The filters or variables to apply to the report before execution, supplied in the ReportParams common structure. For information about the ReportParams structure, see Replacing Filters and Variables in a Report Using the ReportParams Structure in the Siebel Analytics Web SOAP API.

This parameter is optional.

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.

Siebel Analytics Web Administration Guide