Jump to

• Request
• Response
• Examples

Retrieve a list of option lists

get

/api/REST/1.0/assets/optionLists

Retrieves all option lists that match the criteria specified by the request parameters.

Request

Supported Media Types

• application/json

Query Parameters

• count: integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth: string
  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 minimal by default.
• lastUpdatedAt: integer
  The date and time the option list was last updated.
• orderBy: string
  Specifies the field by which list results are ordered.
• page: integer
  Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
• search: string
  Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : QueryResultOptionList

Type: object

Title: QueryResultOptionList

Show Source

• elements: array elements
  Array of option list fields.
• page: integer
  The specified page.
• pageSize: integer
  The page size.
• total: integer
  The total amount of results.
• type: string
  The asset's type in Eloqua.

{
    "title":"QueryResultOptionList",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua."
        },
        "elements":{
            "type":"array",
            "description":"Array of option list fields.",
            "items":{
                "$ref":"#/definitions/OptionListRest10"
            }
        },
        "total":{
            "type":"integer",
            "description":"The total amount of results."
        },
        "pageSize":{
            "type":"integer",
            "description":"The page size."
        },
        "page":{
            "type":"integer",
            "description":"The specified page."
        }
    }
}

Nested Schema : elements

Type: array

Array of option list fields.

Show Source

• Array of: object OptionList
  Title: OptionList

{
    "type":"array",
    "description":"Array of option list fields.",
    "items":{
        "$ref":"#/definitions/OptionListRest10"
    }
}

Nested Schema : OptionList

Type: object

Title: OptionList

Show Source

• createdAt: string
  Read Only: true

  Unix timestamp for the date and time the option list was created.
• createdBy: string
  Read Only: true

  The login id of the user who created the option list.
• currentStatus: string
  The option list's current status.
• depth: string
  Read Only: true

  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.
• description: string
  The description of the option list.
• elements: array elements
  A list of option elements.
• id: string
  Read Only: true

  The option list's unique identifier.
• name: string
  The name of the option list.
• permissions: string
  The permissions for the option list granted to your current instance. This is a read-only property.
• type: string
  The option list's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the option list was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the option list.

{
    "title":"OptionList",
    "properties":{
        "type":{
            "type":"string",
            "description":"The option list's type in Eloqua. This is a read-only property."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The option list's unique identifier."
        },
        "currentStatus":{
            "type":"string",
            "description":"The option list's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the option list."
        },
        "description":{
            "type":"string",
            "description":"The description of the option list."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the option list granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the option list."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the option list was created."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the option list."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the option list was last updated."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "elements":{
            "type":"array",
            "description":"A list of option elements.",
            "items":{
                "$ref":"#/definitions/OptionRest10"
            }
        }
    }
}

Nested Schema : elements

Type: array

A list of option elements.

Show Source

• Array of: object Option
  Title: Option

{
    "type":"array",
    "description":"A list of option elements.",
    "items":{
        "$ref":"#/definitions/OptionRest10"
    }
}

Nested Schema : Option

Type: object

Title: Option

Show Source

• displayName: string
  The display name for the option that is displayed within the option list.
• type: string
  The asset's type in Eloqua. This is a read-only property. This asset is an "Option".
• value: string
  The option's internal value. This value is not displayed externally.

{
    "title":"Option",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. This asset is an \"Option\"."
        },
        "displayName":{
            "type":"string",
            "description":"The display name for the option that is displayed within the option list."
        },
        "value":{
            "type":"string",
            "description":"The option's internal value. This value is not displayed externally."
        }
    }
}

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 option lists using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the first 2 option lists in your database:

GET /api/REST/1.0/assets/optionLists?count=2
			

Response:

{
    "elements":[
        {
            "type":"OptionList",
            "id":"1",
            "depth":"minimal",
            "name":"Lead Rating"
        },
        {
            "type":"OptionList",
            "id":"2",
            "depth":"minimal",
            "name":"Company Revenue"
        }
    ],
    "page":1,
    "pageSize":2,
    "total":16
}
			

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/optionLists?count=2
			

Back to Top