|
Oracle® Business Intelligence Web Services Guide > Description of Services in Oracle BI Web Services > MetadataService Service >
describeSubjectArea() Method
Use this method to retrieve subject area information about the specified subject area. Signature
SASubjectArea describeSubjectArea (String subjectAreaName, SASubjectAreaDetails detailsLevel, String sessionID);
|
|
String subjectAreaName |
Specifies the subject area to be queried. |
SASubjectAreaDetails detailsLevel |
Specifies the information to be retrieved about the subject area. For information on the SASubjectAreaDetails structure, read SASubjectAreaDetails Values. |
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
SASubjectAreaDetails Values
Use this method to specify what information should be retrieved about the subject area. Table 40 lists the available values.
Table 40. 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 more information, read SASubjectArea Structure). Usage
Depending on the value of the detailsLevel parameter, the returned object contains the information specified in Table 41.
Table 41. detailsLevel Values
|
|
IncludeTables |
Specifies that the 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 |
Specifies that the 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 |
Specifies that the table list is not available. The tables field in the resulting subject area object is null. |
| 
