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

ReportFolderRead

Extracts report and dashboard folder configuration data.

Usage

Use the ReportFolderRead method to read the details of a specified folder and its role associations. The following privileges are required:

• Manage Roles and Access.
• To read role associations for report folders: Manage Custom Reports.
• To read role associations for dashboard folders: Manage Dashboards.
• To read role associations for the V3 migrated company wide shared folders: Access Migrated Company Wide Shared Folder.

The <Path> child element of apQuery:ReportFolder is required to query folders containing reports or dashboards. 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 V3 catalogs, then results for V3 catalogs are returned.

For the folders in the Company Wide Shared Folder, the root folder is /shared/Company Analyses, and for the folders in the Migrated Company Wide Shared Folder, the root folder is /shared/Migrated Company Analyses.

You can query the root folder with the <Path> element as in the following example:

<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.

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

Arguments

Table 160 describes the arguments taken by the ReportFolderRead method.

Return Value of the Call

The folder configuration data is returned.