1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 2.0
  5. Custom object data

Retrieve a list of custom object data

get

/api/rest/2.0/data/customObject/{parentId}/instances

Retrieves the data (records) for all custom objects that match the criteria specified by the request parameters.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • 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.
  • Specifies the field by which list results are ordered.
  • Specifies which page of custom object data assets to return (the count parameter defines the number of custom object data assets per page). If the page parameter is not supplied, 1 will be used by default.
  • Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultCustomObjectData
Type: object
Title: QueryResultCustomObjectData
Show Source
Nested Schema : elements
Type: array
Array of custom object field elements.
Show Source
Nested Schema : CustomObjectData
Type: object
Title: CustomObjectData
Show Source
  • The account record Id associated to this custom object data. This is a read-only property.
  • The contact record Id associated to this custom object data.
  • Read Only: true
    The date and time the custom object data was created, expressed in Unix time. This is a read-only property.
  • Read Only: true
    The login id of the user who created the custom object data. This is a read-only property.
  • The custom object data's current status.
  • The record status of the custom object data.
  • 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.
  • The description of the custom object data.
  • fieldValues
    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.
  • Read Only: true
    The folder id of the folder which contains the custom object data.
  • Read Only: true
    Id of the custom object data.
  • Whether or not the custom object data is mapped to a custom object.
  • The name of the custom object data.
  • permissions
    The permissions for the custom object data granted to your current instance. This is a read-only property.
  • Read Only: true
    The date the custom object data is scheduled.
  • Id of the template used to create the asset.
  • The asset's type in Eloqua. This is a read-only property.
  • The unique code associated to the custom object data.
  • Read Only: true
    Unix timestamp for the date and time the custom object data was last updated.
  • Read Only: true
    The login id of the user that last updated the custom object data.
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
  • Read Only: true
    The id of the field to be set to the corresponding value.
  • Name of the field value.
  • The asset's type in Eloqua. This is a read-only property.
  • The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

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 first 2 custom object data assets in your database:


GET /api/REST/2.0/data/customObject/12/instances?count=2

Response:


{
    "elements":[
        {
            "type":"CustomObjectDataAsset",
            "id":"5",
            "createdAt":"1402929826",
            "createdBy":"2",
            "depth":"minimal",
            "description":"Opportunity",
            "name":"Opportunity",
            "updatedAt":"1402929826",
            "updatedBy":"2"
        },
        {
            "type":"CustomObjectDataAsset",
            "id":"6",
            "createdAt":"1402929826",
            "createdBy":"2",
            "depth":"minimal",
            "description":"Purchase History",
            "name":"Purchase History",
            "updatedAt":"1402929827",
            "updatedBy":"2"
        }
    ],
    "page":1,
    "pageSize":2,
    "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/instances?count=2
Back to Top