Retrieve an option list

get

/api/REST/1.0/assets/optionList/{id}

Retrieves the option list specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : OptionList
Type: object
Title: OptionList
Show Source
Nested Schema : elements
Type: array
A list of option elements.
Show Source
Nested Schema : Option
Type: object
Title: Option
Show Source

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

The following examples demonstrate how to retrieve an option list using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the option list asset with Id #6:


GET /api/REST/1.0/assets/optionList/6?depth=complete
			

Response:


{
    "type":"OptionList",
    "id":"6",
    "depth":"complete",
    "name":"Job Role",
    "elements":[
        {
            "type":"Option",
            "displayName":"-- Please Select --",
            "value":""
        },
        {
            "type":"Option",
            "displayName":"Management / Executive",
            "value":"Management / Executive"
        },
        {
            "type":"Option",
            "displayName":"Professional / Consulting",
            "value":"Professional / Consulting"
        },
        {
            "type":"Option",
            "displayName":"Departmental Manager",
            "value":"Departmental Manager"
        },
        {
            "type":"Option",
            "displayName":"Finance / Purchasing",
            "value":"Finance / Purchasing"
        },
        {
            "type":"Option",
            "displayName":"Operations",
            "value":"Operations"
        },
        {
            "type":"Option",
            "displayName":"IT / Technical",
            "value":"IT / Technical"
        },
        {
            "type":"Option",
            "displayName":"Other / Not Applicable",
            "value":"Other / Not Applicable"
        }
    ]
}
			

cURL Example

Here is the same example in cURL given an instance with the name APITest, username API.User, and POD of 3.


curl --user "APITest\API.User" --request GET https://secure.p03.eloqua.com/api/REST/1.0/assets/optionList/6?depth=complete
			
Back to Top