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 >

Getting an HTML Excerpt to Display in Results Using the getHTMLForReport() Method in the Siebel Analytics Web SOAP API

The getHTMLForReport() method in the HtmlViewService service gets an HTML excerpt to display the results for a particular report. Before issuing this call, use the addReportToPage method to add the results to an HTML page.

For more information about the addReportToPage method, see Adding Results to an HTML Page Using the addReportToPage() Method in the Siebel Analytics Web SOAP API.

For information about the HtmlViewService service, see Overview of the Siebel Analytics Web HtmlViewService Service.

Description of Parameters in the getHTMLForReport() Method

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

Parameter
Description

String pageID

A character string page ID returned by the createPage() method.

For information about the startPage () method, see Creating a New Page Object Using the startPage() Method in the Siebel Analytics Web SOAP API

String pageReportID

A character string ID returned by the addReportToPage() method.

For information about the addReportToPage method, see Adding Results to an HTML Page Using the addReportToPage() Method in the Siebel Analytics Web SOAP API.

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