Retrieve custom object data

get

/api/REST/2.0/data/customObject/{parentId}/instance/{id}

Retrieves the data (records) for the custom object specified by the {parentId} and id parameters.

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 : CustomObjectData
Type: object
Title: CustomObjectData
Show Source
Nested Schema : fieldValues
Type: array
Array containing 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.
Show Source
Nested Schema : permissions
Type: array
The permissions for the custom object data granted to your current instance. This is a read-only property.
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
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 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, and a record Id #19:


GET /api/REST/2.0/data/customObject/12/instance/19
			

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/2.0/data/customObject/12/instance/19
			
Back to Top