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.
The input argument <Version> specifies the release of Oracle CRM On Demand for which configuration data is returned. The default value is 40, and specified values up to and including 40 return configuration data applicable to Oracle CRM On Demand Release 40.
If the value specified is greater than 40, then all of the configuration data up to the release specified is returned. For example, if a value of 41 is specified, then all of the configuration data in Release 40 plus the newer data up to Release 41 is returned (which includes the <Description> element).
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
The following table describes the arguments taken by the PicklistRead method.
| Name | Description | Required | Default | I/O |
|---|---|---|---|---|
|
Version |
Specifies the release of Oracle CRM On Demand for which configuration data is returned. |
No |
40 |
Input |
|
apQuery:PicklistSet |
The picklist query criteria. |
Yes |
Not applicable |
Input |
apData:ListOfPicklistSet |
The extracted picklist data. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The picklists for the object are returned.