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.

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 <FolderName> and <ParentFolder> child elements.

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.

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

Arguments

Table 148 describes the arguments taken by the ReportFolderRead method.

Table 148. Arguments Taken by the ReportFolderRead Method
Name
Description
Required
Default
I/O

apQuery:ReportFolder

The report folder query criteria.

Yes

Not applicable

Input

apData:ListOfReportFolder

The extracted report folder data.

Not applicable

Not applicable

Output

Return Value of the Call

The report folder configuration data is returned.

Oracle Web Services On Demand Guide, Version 21.0 (Oracle CRM On Demand Release 33) Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.