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

Retrieve a list of custom objects

get

/api/rest/2.0/assets/customObjects

Retrieves all custom objects that match the criteria specified by the request parameters.

Request

Supported Media Types
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.
  • Unix timestamp for the date and time the custom object was last updated.
  • Specifies the field by which list results are ordered.
  • 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.
  • 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 : QueryResultCustomObject
Type: object
Title: QueryResultCustomObject
Show Source
Nested Schema : elements
Type: array
Array of custom object fields.
Show Source
Nested Schema : CustomObject
Type: object
Title: CustomObject
Show Source
  • Read Only: true
    The date and time the custom object was created, expressed in Unix time.
  • Read Only: true
    The login id of the user who created the custom object.
  • This property is not used for custom objects.
  • Whether or not custom object records are deleted when linked contact records are deleted. Does not apply to records that are unmapped or account deletion. Deleting records is irreversible and data cannot be recovered. The default value is false. This feature is released under our Controlled Availability program. You can request access to this feature by submitting a request to My Oracle Support.
  • 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.
  • For your custom object record to have a meaningful name field, you must create a custom object field which will act as a name. You can then use the desired custom object field's id as the value for this parameter.
  • For your custom object record to have an email address field, you must create a custom object field which will act as an email address. You can then use the desired custom object field's id as the value for this parameter.
  • fields
    Array consisting of custom object field properties.
  • Read Only: true
    This property is not used for custom objects.
  • Read Only: true
    Id of the custom object.
  • The name of the custom object.
  • permissions
    The permissions for the custom object granted to your current instance. This is a read-only property.
  • Read Only: true
    This property is not used for custom objects.
  • This property is not used for custom objects.
  • The asset's type in Eloqua. This is a read-only property.
  • For your custom object record to have a unique identifier, you must create a custom object field which will act as a GUID. You can then use the desired custom object field's id as the value for this parameter.
  • Read Only: true
    Unix timestamp for the date and time the custom object was last updated.
  • Read Only: true
    The login id of the user that last updated the custom object.
Nested Schema : fields
Type: array
Array consisting of custom object field properties.
Show Source
Nested Schema : permissions
Type: array
The permissions for the custom object granted to your current instance. This is a read-only property.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
Nested Schema : permissions
Type: array
This property is not used.
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 custom objects using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the first 2 custom objects in your database:


GET /api/REST/2.0/assets/customObjects?count=2

Response:


{
    "elements":[
        {
            "type":"CustomObject",
            "id":"5",
            "createdAt":"1402929826",
            "createdBy":"2",
            "depth":"minimal",
            "description":"Opportunity",
            "name":"Opportunity",
            "updatedAt":"1402929826",
            "updatedBy":"2"
        },
        {
            "type":"CustomObject",
            "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/assets/customObjects?count=2
Back to Top