Retrieve a list of custom object data
get
/api/REST/1.0/data/customObject/{id}
Retrieves the data for the custom object specified by the
id
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the custom object.
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.
-
lastUpdatedAt: integer
Unix timestamp for the date and time the custom object was last updated. This is a read-only property.
-
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.
Response
Supported Media Types
- application/json
200 Response
OK.
Root Schema : QueryResultCustomObjectData
Type:
object
Title:
Show Source
QueryResultCustomObjectData
-
elements:
array elements
Array of custom object field elements.
-
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.
Nested Schema : elements
Type:
array
Array of custom object field elements.
Show Source
-
Array of:
object CustomObjectData
Title:
CustomObjectData
Nested Schema : CustomObjectData
Type:
object
Title:
Show Source
CustomObjectData
-
contactId:
string
Id of the contact. This is a read-only property.
-
currentStatus:
string
The custom object's current status. This is a read-only property.
-
fieldValues:
array fieldValues
Array containing
type
andid
values for all of the fields associated with a given custom object data asset. Custom object date field values must be in Unix time format. -
id:
string
Read Only:
true
Id of the custom object. This is a read-only property. -
type:
string
The asset's type in Eloqua. This is a read-only property.
Nested Schema : fieldValues
Type:
array
Array containing
Show Source
type
and id
values for all of the fields associated with a given custom object data asset. Custom object date field values must be in Unix time format.-
Array of:
object FieldValue
Title:
FieldValue
Nested Schema : FieldValue
Type:
object
Title:
Show Source
FieldValue
-
id:
string
Read Only:
true
The id of the field to be set to the corresponding value. -
type:
string
The asset's type in Eloqua. This is a read-only property.
-
value:
string
The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.
204 Response
No matching custom objects were found in the search.
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 retrieve data for custom objects using an HTTP request and cURL. For more information on requests, see API requests.
HTTP Request Example
Retrieve the data for the custom object asset with Id #12:
GET /api/REST/1.0/data/customObject/12
Response:
{
"elements":[
{
"type":"CustomObjectData",
"id":"19",
"fieldValues":[
{
"type":"FieldValue",
"id":"102",
"value":"Mutant"
},
{
"type":"FieldValue",
"id":"103",
"value":"mutant@mutant.com"
}
]
},
{
"type":"CustomObjectData",
"id":"20",
"fieldValues":[
{
"type":"FieldValue",
"id":"102",
"value":"Gambit"
},
{
"type":"FieldValue",
"id":"103",
"value":"gambit@mutant.com"
}
]
}
],
"page":1,
"pageSize":1000,
"total":2
}
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/data/customObject/12