|
Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > WebCatalogService Service >
readObject() Method
The readObject() method reads an object from the Web Catalog and returns CatalogObject structure. Signature
CatalogObject readObject(String path, boolean returnXmlString, String sessionID);
|
|
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. |
Returns
Returns a CatalogObject structure containing the specified object from the Web Catalog. For a description of the CatalogObject structure, read CatalogObject Structure.
|
