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

FieldManagementRead

Extracts field management configuration data.

Usage

Use the FieldManagementRead method to extract field management configuration data for an object.

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

If the <IncludeAll> child element of apQuery:FieldSet 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.

Regardless of whether only customized data is returned, or preconfigured and customized data, translated data for all languages enabled by the company are included in the output.

See FieldManagementUpsert for information about the field management data specified in apData:FieldSet.

By default, FieldManagementRead only extracts field definitions for fields that have been created by the user, or preconfigured fields that have been modified. Unmodified preconfigured fields are bypassed because they exist on all company instances. See the information in this section about <IncludeAll> for details on how to include all fields, including preconfigured fields, in the SOAP response.

NOTE:  Configuration data is for returned for the Call Activity History record type even though it is not exposed in the Oracle CRM On Demand UI.

Arguments

Table 118 describes the arguments taken by the FieldManagementRead method.

Return Value of the Call

The field management data is returned.