Bookshelf Home | Contents | Index | PDF     

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 >

Applying Parameters to a Report Using the applyReportParams() Method in the Siebel Analytics Web SOAP API

The applyReportParams() method in the ReportEditingService service applies report parameters to the report and returns the results.

Description of Parameters in the applyReportParams Method()

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

Parameter
Description

ReportRef object

The path to the report definition, supplied in the ReportRef common structure. For information about the ReportRef structure, see Referencing a Report Using the ReportRef Structure in the Siebel Analytics Web SOAP API.

ReportParams reportParams

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

This parameter is optional.

Boolean encodeInString

A Boolean value, 1 (true) or 0 (false).

When set to true, it indicates that 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.
    
Siebel Analytics Web Administration Guide