Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > MetadataService Service >
describeTable() Method
Retrieves table information for a specified table in a specified subject area. Signature
SATable describeTable (String subjectAreaName, String tableName, SATableDetails detailsLevel, String sessionID);
|
|
String subjectAreaName |
String to specify the subject area to be queried. |
String tableName |
String to specify the table to be queried. |
SATableDetails detailsLevel |
Specifies what information should be retrieved about the table. For information on the SATableDetails structure, read SATablesDetails Values. |
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. |
SATablesDetails Values
Used to specify what information should be retrieved about the table. Table 31 lists the available values.
Table 31. SATableDetails Values
|
|
IncludeColumns |
Populate the columns field in the SATable Object. |
Minimum |
Do not include column information. The columns field in the SATable Object is set to null. |
Returns
Returns an SATable Object. For information on the SATable structure, read SATable Structure.
|