Jump to

• Request
• Response
• Examples

Retrieve the synced data for a custom object export definition

get

/api/bulk/2.0/customObjects/{parentId}/exports/{id}/data

Retrieves the synced data for a custom object export definition.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  The custom object export's resource identification number.
• parentId(required): integer
  The custom object's resource identification number.

Query Parameters

• limit: integer
  A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 50,000 inclusive. If not specified, the default is 1000. Example: ?limit=5.
• links: string
  The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
• offset: integer
  Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: ?offset=1000.
• totalResults: boolean
  Whether or not the total results are shown, and factored into the hasMore property in the response. When set to false, the totalResults property will not be returned, and the hasMore property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is true.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CustomObjectExportDataQueryResponse

Type: object

Title: CustomObjectExportDataQueryResponse

The response body includes information about the synced data for the custom object export definition.

Show Source

• count: integer
  Title: count

  Number of results returned in the request.
• hasMore: boolean
  Title: hasMore

  Indicates if there are more results.
• items: array items
  Title: items

  A list of the custom object's export data.
• limit: integer
  Title: limit

  The maximum number of records returned. Set with the limit URL parameter, and defaults to 1000 if not specified.
• offset: integer
  Title: offset

  The requested index from which records are returned. Set with the offset URL parameter, and defaults to 0 if not specified.
• totalResults: integer(int64)
  Title: totalResults

  Number of total results. Returned when the totalResults URL parameter is not set to false.

{
    "title":"CustomObjectExportDataQueryResponse",
    "description":"The response body includes information about the synced data for the custom object export definition.",
    "properties":{
        "count":{
            "title":"count",
            "description":"Number of results returned in the request.",
            "type":"integer"
        },
        "hasMore":{
            "title":"hasMore",
            "description":"Indicates if there are more results.",
            "type":"boolean"
        },
        "items":{
            "title":"items",
            "description":"A list of the custom object's export data.",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "limit":{
            "title":"limit",
            "description":"The maximum number of records returned. Set with the <code>limit</code> URL parameter, and defaults to 1000 if not specified.",
            "type":"integer"
        },
        "offset":{
            "title":"offset",
            "description":"The requested index from which records are returned. Set with the <code>offset</code> URL parameter, and defaults to 0 if not specified.",
            "type":"integer"
        },
        "totalResults":{
            "format":"int64",
            "title":"totalResults",
            "description":"Number of total results. Returned when the <code>totalResults</code> URL parameter is not set to <code>false</code>.",
            "type":"integer"
        }
    }
}

Nested Schema : items

Type: array

Title: items

A list of the custom object's export data.

Show Source

• Array of: object items

{
    "title":"items",
    "description":"A list of the custom object's export data.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

The following examples demonstrate how to retrieve synced data for a custom object export definition using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

Retrieve the synced data for the custom object with id #9 and export definition with the id #32091:

GET /customObjects/9/exports/32091/data 
			

Note:

Custom objects are unique to each Eloqua installation. Examples here will not map directly to your custom objects and their fields. You can obtain a list of all custom objects using the GET /customObjects endpoint. Once you have a custom object's id #, you can retrieve its field list by using the GET /customobjects/{id}/fields endpoint: this will allow you to create accurate import/export definitions.

Response:

{
    "totalResults":1,
    "limit":1000,
    "offset":0,
    "count":0,
    "hasMore":false,
    "items":[
        {
            "ID":"DPLTO00000000001",
            "Inflated":"yes"
        }
        {
            "ID":"DPLTO00000000002",
            "Inflated":"no"
        }
        {
            "ID":"DPLTO00000000003",
            "Inflated":"yes"
        }
    ]
}
			

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/bulk/2.0/customObjects/9/exports/32091/data 
			

Back to Top