Oracle Web Services On Demand Guide > Web Services On Demand API Calls > Administrative Services API Calls >

ReportFolderRead

Extracts report folder configuration data.

Usage

Use the ReportFolderRead method to read the details of a specified folder and its role associations. The Manage Content privilege is required and to access V3 migrated company wide shared folders, the Access Migrated Company Wide Shared Folder privilege is required.

The <Path> child element of apQuery:ReportFolder is required to query report folders. You can query using only the <Path> element, but you can also include the <Catalog>, <FolderName>, and <ParentFolder> child elements.

If <Catalog> is not specified in the request, and the path exists in both V2 and V3 catalogs, then results for both V2 and V3 catalogs are returned.

For both V2 and V3 catalogs, the root report folder is /shared/Company Analyses, and all folders come under this root folder. You can query the root folder with the <Path> element as follows:

<quer:Path>/shared/Company Analyses</quer:Path>

To query for a specific subfolder, you use the <Path> element as in the following example:

<quer:Path>/shared/Company Analyses/Activity Book Visibility</quer:Path>.

where /shared/Company Analyses/Activity Book Visibility is the path to that particular folder.

NOTE:  Depending on how your company instance is set up, your company might not have access to the V3 catalog.

See ReportFolderUpsert for information about the report folder data specified in apData:ReportFolder.

Arguments

Table 154 describes the arguments taken by the ReportFolderRead method.

Return Value of the Call

The report folder configuration data is returned.