Create an option list
post
/api/REST/1.0/assets/optionList
Creates an option list that matches the criteria specified by the request body.
Request
Supported Media Types
- application/json
The request body defines the details of the option list to be created.
Root Schema : OptionList
Type:
object
Title:
Show Source
OptionList
-
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
, andcomplete
. Any other values passed are reset tocomplete
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.
Nested Schema : elements
Type:
array
A list of option elements.
Show Source
-
Array of:
object Option
Title:
Option
Nested Schema : Option
Type:
object
Title:
Show Source
Option
-
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.
Response
Supported Media Types
- application/json
201 Response
Success.
Root Schema : OptionList
Type:
object
Title:
Show Source
OptionList
-
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
, andcomplete
. Any other values passed are reset tocomplete
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.
Nested Schema : elements
Type:
array
A list of option elements.
Show Source
-
Array of:
object Option
Title:
Option
Nested Schema : Option
Type:
object
Title:
Show Source
Option
-
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.
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.
Examples
The following examples demonstrate how to create a new option list using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Create a new option list:
POST /api/REST/1.0/assets/optionList
Content-Type: application/json
Request body:
{
"name":"Favorite Candy",
"elements":[
{
"type":"Option",
"displayName":"-- Please Select --",
"value":"no selection"
},
{
"type":"Option",
"displayName":"Chocolate",
"value":"chocolate"
},
{
"type":"Option",
"displayName":"Licorice",
"value":"licorice"
},
{
"type":"Option",
"displayName":"Gumdrops",
"value":"gumdrops"
},
{
"type":"Option",
"displayName":"Peppermint",
"value":"peppermint"
},
{
"type":"Option",
"displayName":"Caramel",
"value":"caramel"
}
]
}
Note:
The options in an option list are displayed in the order they appear in the "elements" array. It's good practice to have a default selection such as above ("-- Please Select --") so you don't artificially skew your results.Response:
{
"type":"OptionList",
"id":"23",
"createdAt":"1435677162",
"createdBy":"19",
"depth":"complete",
"name":"Favorite Candy",
"updatedAt":"1435677162",
"updatedBy":"19",
"elements":[
{
"type":"Option",
"displayName":"-- Please Select --",
"value":"no selection"
},
{
"type":"Option",
"displayName":"Chocolate",
"value":"chocolate"
},
{
"type":"Option",
"displayName":"Licorice",
"value":"licorice"
},
{
"type":"Option",
"displayName":"Gumdrops",
"value":"gumdrops"
},
{
"type":"Option",
"displayName":"Peppermint",
"value":"peppermint"
},
{
"type":"Option",
"displayName":"Caramel",
"value":"caramel"
}
]
}
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" --header "Content-Type: application/json" --request POST --data '{"name":"Favorite Candy","elements":[{"type":"Option","displayName":"-- Please Select --","value":"no selection"},{"type":"Option","displayName":"Chocolate","value":"chocolate"},{"type":"Option","displayName":"Licorice","value":"licorice"},{"type":"Option","displayName":"Gumdrops","value":"gumdrops"},{"type":"Option","displayName":"Peppermint","value":"peppermint"},{"type":"Option","displayName":"Caramel","value":"caramel"}]}' https://secure.p03.eloqua.com/api/REST/1.0/assets/optionList