RelatedInformationLayoutRead
Extracts all of the related information layout data for an object.
Usage
Use the RelatedInformationLayoutRead method to read all of the related information layout data for an object.
The object is specified with the <ObjectName> child element of apQuery:RelatedInformationLayout.
If the <CurrentUserOnly> child element of apQuery:RelatedInformationLayout specifies true, related information layout data for the current user only is returned.
If the <IncludeAll> child element of apQuery:RelatedInformationLayout 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 <Version> child element of apQuery:RelatedInformationLayout specifies the release of Oracle CRM On Demand for which configuration data is extracted. The default value is 31, so to extract Release 32 or later functionality, you must specify a higher value than 31.
See RelatedInformationLayoutUpsert for information about the related information layout data specified in apData:RelatedInformationLayout.
Arguments
The following table describes the arguments taken by the RelatedInformationLayoutRead method.
Name | Description | Required | Default | I/O |
---|---|---|---|---|
apQuery:RelatedInformationLayout |
The related information layout query criteria. |
Yes |
Not applicable |
Input |
apData:ListOfRelatedInformationLayout |
The extracted related information layout data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The related information layout data is returned.