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 >

Reading a Web Catalog Object Using the readObject() Method in the Siebel Analytics Web SOAP API


The readObject() method in the WebCatalogService service reads an object from the Web Catalog and returns CatalogObject structure.

For a description of the CatalogObject structure, see Specifying Information for a Web Catalog Object Using the CatalogObject Structure in the Siebel Analytics Web SOAP API

Description of Parameters in the readObject() Method

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

Parameter
Description

String path

The location where the retrieved object should be placed.

Boolean returnXmlString

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

When set to true, the catalogObject field returned in the CatalogObject structure is a character string that contains the XML representation of the object stored in the Web Catalog.

When set to false, the SOAP client needs to analyze the xsi:type attribute of the root node of the returned XML to determine the type of object to create. If the xsi:type attribute is unknown, an exception may be thrown depending on the SOAP client's implementation.

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