PageLayoutRelatedInformationRead
Extracts all of the related information for a detail page layout for an object.
Usage
Use the PageLayoutRelatedInformationRead method to read all of the related information data for an object.
The object is specified with the <ObjectName> child element of apQuery:PageLayoutRelatedInformation.
If the <CurrentUserOnly> child element of apQuery:PageLayoutRelatedInformation specifies true, related information data for the current user only is returned.
If the <IncludeAll> child element of apQuery:PageLayoutRelatedInformations 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.
The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 41, and specified values up to and including 41 return configuration data applicable to Oracle CRM On Demand Release 41.
If the value specified is greater than 41, then all of the configuration data up to the release specified is returned. For example, if a value of 42 is specified, then all of the configuration data in Release 41 plus the newer data up to Release 42 is returned (which includes the <NewRecordLayout> element).
See PageLayoutRelatedInformationUpsert for information about the page layout related information specified in apData:PageLayoutRelatedInformation.
Arguments
The following table describes the arguments taken by the PageLayoutRelatedInformationRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
Version |
Specifies the release of Oracle CRM On Demand for which configuration data is returned. |
No |
41 |
Input |
|
apQuery:PageLayoutRelatedInformation |
The related information query criteria. |
Yes |
Not applicable |
Input |
apData:ListOfPageLayoutRelatedInformation |
The extracted page layout related information. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The page layout related information is returned.