Jump to

• Request
• Response
• Examples

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

• application/json

Path Parameters

• parentId: integer
  Id of the parent.

Query Parameters

• count(optional): integer
  Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
• depth(optional): 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.
• orderBy(optional): string
  Specifies the field by which list results are ordered.
• page(optional): integer
  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.
• search(optional): 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 : QueryResultCustomObjectData

Type: object

Title: QueryResultCustomObjectData

Show Source

• elements(optional): array elements
  Array of custom object field elements.
• page(optional): integer
  The specified page.
• pageSize(optional): integer
  The page size.
• total(optional): integer
  The total amount of results.
• type(optional): string
  The asset's type in Eloqua.

{
    "title":"QueryResultCustomObjectData",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. "
        },
        "elements":{
            "type":"array",
            "description":"Array of custom object field elements.",
            "items":{
                "$ref":"#/definitions/CustomObjectDataRest20"
            }
        },
        "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 custom object field elements.

Show Source

• Array of: object CustomObjectData
  Title: CustomObjectData

{
    "type":"array",
    "description":"Array of custom object field elements.",
    "items":{
        "$ref":"#/definitions/CustomObjectDataRest20"
    }
}

Nested Schema : CustomObjectData

Type: object

Title: CustomObjectData

Show Source

• accessedAt(optional): string
  Read Only: true

  The date and time the custom object data was last accessed, expressed in Unix time.
• accountId(optional): string
  The account record Id associated to this custom object data. This is a read-only property.
• contactId(optional): string
  The contact record Id associated to this custom object data.
• createdAt(optional): string
  Read Only: true

  The date and time the custom object data was created, expressed in Unix time. This is a read-only property.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the custom object data. This is a read-only property.
• currentStatus(optional): string
  The custom object data's current status.
• customObjectRecordStatus(optional): string
  The record status of the custom object data.
• depth(optional): 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(optional): string
  The description of the custom object data.
• fieldValues(optional): array 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.
• folderId(optional): string
  Read Only: true

  The folder id of the folder which contains the custom object data.
• id(optional): string
  Read Only: true

  Id of the custom object data.
• isMapped(optional): string
  Whether or not the custom object data is mapped to a custom object.
• name(optional): string
  The name of the custom object data.
• permissions(optional): array permissions
  The permissions for the custom object data granted to your current instance. This is a read-only property.
• scheduledFor(optional): string
  Read Only: true

  The date the custom object data is scheduled.
• sourceTemplateId(optional): string
  Id of the template used to create the asset.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• uniqueCode(optional): string
  The unique code associated to the custom object data.
• updatedAt(optional): string
  Read Only: true

  Unix timestamp for the date and time the custom object data was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the custom object data.

{
    "title":"CustomObjectData",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the custom object data."
        },
        "currentStatus":{
            "type":"string",
            "description":"The custom object data's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the custom object data."
        },
        "description":{
            "type":"string",
            "description":"The description of the custom object data."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the custom object data granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the custom object data."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the custom object data. This is a read-only property."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the custom object data was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the custom object data."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the custom object data was last updated."
        },
        "accessedAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the custom object data was last accessed, expressed in Unix time."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"The date the custom object data is scheduled."
        },
        "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>."
        },
        "contactId":{
            "type":"string",
            "description":"The contact record Id associated to this custom object data."
        },
        "accountId":{
            "type":"string",
            "description":"The account record Id associated to this custom object data. This is a read-only property."
        },
        "uniqueCode":{
            "type":"string",
            "description":"The unique code associated to the custom object data."
        },
        "customObjectRecordStatus":{
            "type":"string",
            "description":"The record status of the custom object data."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> 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.",
            "items":{
                "$ref":"#/definitions/FieldValueRest20"
            }
        },
        "isMapped":{
            "type":"string",
            "description":"Whether or not the custom object data is mapped to a custom object."
        }
    }
}

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

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> 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.",
    "items":{
        "$ref":"#/definitions/FieldValueRest20"
    }
}

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

• Array of: string

{
    "type":"array",
    "description":"The permissions for the custom object data granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• name(optional): string
  Name of the field value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        },
        "name":{
            "type":"string",
            "description":"Name of the field value."
        }
    }
}

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