AccessProfileReadAll

Extracts all of the access profile configuration data for a company.

Usage

Use the AccessProfileReadAll method to read all of the access profiles. The Manage Roles and Access privilege is required.

The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 27, and specified values up to and including 27 return configuration data applicable to Oracle CRM On Demand Release 27.

If the value specified is greater than 27, then all of the configuration data up to the release specified is returned. For example, if a value of 28 is specified, then all of the configuration data in Release 27 plus the newer data up to Release 28 is returned (which includes the <NameTranslation> and <AccessProfileID> elements).

The input argument <SortSpecification> allows you to:

  • Sort the access profiles in the output by access profile name.

  • Sort the access objects for each access profile by access object name.

The format for the <SortSpecification> input argument is:

Name sortorder, AccessObjectName sortorder

where sortorder can be ASC for sorting in ascending order, or DESC for sorting in descending order. If sortorder is not specified, then the sort order is ascending by default.

If you do not specify Name, or if <SortSpecification> has a blank value, then the Edit, Full, and ReadOnly access profiles appear at the start of the output, followed by the remaining access profiles in no specific order. If you do not specify AccessObjectName, or if <SortSpecification> has a blank value, then the access objects for each access profile are listed in no specific order.

See AccessProfileUpsert for information about the access profile data specified in apData:AccessProfile.

Arguments

The following table describes the arguments taken by the AccessProfileReadAll method.

Table Arguments Taken by the AccessProfileReadAll Method

Name Description Required Default I/O

Version

Specifies the release of Oracle CRM On Demand for which configuration data is returned.

No

27

Input

SortSpecification

A sort specification.

No

None

Input

apData:ListOfAccessProfile

The extracted data for all access profiles.

Not applicable

Not applicable

Output

Return Value of the Call

The access profiles are returned.