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

PageLayoutFieldReadAll


Extracts all of the field configuration data for detail pages for a company.

Usage

Use the PageLayoutFieldReadAll method to read all of the field data for detail pages.

If the input argument <CurrentUserOnly> specifies true, all of the page layout field data for the current user only is returned.

If the input argument <IncludeAll> specifies true, the method returns all configuration data, including preconfigured and customized data. If <IncludeAll> specifies false, or is not included in the request, the method returns customized configuration data only.

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.

See PageLayoutFieldUpsert for information about the page layout field data specified in apData:PageLayout.

Arguments

Table 141 describes the arguments taken by the PageLayoutFieldReadAll method.

Table 141. Arguments Taken by the PageLayoutFieldReadAll Method
Name
Description
Required
Default
I/O

CurrentUserOnly

If true, extracts data for the current user only.

No

false

Input

IncludeAll

If true, extracts all configuration data and not just customized configuration data.

No

false

Input

Version

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

No

27

Input

apData:ListOfPageLayout

The extracted page layout field data.

Not applicable

Not applicable

Output

Return Value of the Call

The page layout fields are returned.

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