Bookshelf Home | Contents | Index | PDF     

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

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

Table 157 describes the arguments taken by the RelatedInformationLayoutRead method.

Table 157. 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.

    
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.