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

PicklistRead

Extracts picklist configuration data.

Usage

Use the PicklistRead method to extract picklist configuration data for an object.

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

If the <IncludeAll> child element of apQuery:PicklistSet specifies true, then the method returns configuration data including preconfigured and customized data. However, the data returned does not include any pre-configured read-only picklist data. If <IncludeAll> specifies false, or is not included in the request, then the method returns customized configuration data only.

You can use the <Disabled> child element of <PickListValue> to filter for active and inactive (disabled) picklist values for a particular picklist. To filter, you must specify <ObjectName> and <Name> to identify the picklist, and a value for <Disabled>. If you specify a value of true for <Disabled>, all inactive picklist values are returned, and if you specify false, all active picklist values are returned. If you do not specify a value for <Disabled>, both active and inactive picklist values are returned.

See PicklistUpsert for information about the picklist data specified in apData:PicklistSet.

Arguments

Table 148 describes the arguments taken by the PicklistRead method.

Return Value of the Call

The picklists for the object are returned.