Bookshelf Home | Contents | Index | PDF     

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

PageLayoutFieldRead

Extracts all of the field configuration data for a detail page of an object.

Usage

Use the PageLayoutFieldRead method to read the field data for an object's detail page.

The object is specified with the <ObjectName> child element of apQuery:PageLayout.

If the <CurrentUserOnly> child element of apQuery:PageLayout specifies true, page layout field data for the current user only is returned.

If the <IncludeAll> child element of apQuery:PageLayout specifies true, the method returns 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.

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

Arguments

Table 131 describes the arguments taken by the PageLayoutFieldRead method.

Table 131. Arguments Taken by the PageLayoutFieldRead Method
Name
Description
Required
Default
I/O

apQuery:PageLayout

The page layout query criteria.

Yes

Not applicable

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 21.0 (Oracle CRM On Demand Release 33) Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.