|
Siebel Analytics Web Services Guide > Description of Siebel Analytics Web SOAP API Methods > MetadataService Service >
describeSubjectArea() Method
Retrieves subject area information for a specified subject area. Signature
SASubjectArea[] describeSubjectArea (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);
|
|
String subjectAreaName |
String to specify the subject area to be queried. |
SASubjectAreaDetails detailsLevel |
Specifies what information should be retrieved about the subject area. For information on the SASubjectAreaDetails structure, read SASubjectAreaDetails 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. |
SASubjectAreaDetails Values
Used to specify what information should be retrieved about the subject area. Table 29 lists the available values.
Table 29. SASubjectAreaDetails Values
|
|
IncludeTables |
Include table list with minimum information about each table. |
IncludeTablesAndColumns |
Include full table and column information. |
Minimum |
Do not include table and column information. |
Returns
Returns an SASubjectArea Object. For information on the SASubjectArea structure, read SASubjectArea Structure. Usage
Depending on the value of the detailsLevel parameter, the returned Object contains the information specified in Table 30.
Table 30. Contents of SASubjectArea Object Based on detailsLevel Parameter
|
|
IncludeTables |
Tables field is not null and contains the collection of tables for this subject area. Each table object has the columns field set to null. |
InludeTablesAndColumns |
Tables field is not null and contains the collection of tables for this subject area. For each table object the columns field contains the corresponding collection of columns. |
Minimum |
Table list is not available. The tables field in the resulting subject area object is null. |
| 
