1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Bulk
  4. 2.0
  5. customObjects

Create an export definition for a custom object

post

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

Creates a new export definition for the specified custom object. See the tutorial for details on how to export data.

Request

Supported Media Types
Path Parameters
Body ()
The request body contains details of the custom object export definition.
Root Schema : CustomObjectExportIndividual
Type: object
Title: CustomObjectExportIndividual
The request body defines the details of the custom object export definition.
Show Source
  • Title: areSystemTimestampsInUTC
    Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.
  • Title: autoDeleteDuration
    Time until the definition will be deleted, expressed using the ISO-8601 standard.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: crmAccountIdField
    The ML statement for an existing contact field which addresses the CRM account ID.
  • Title: dataRetentionDuration
    The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
  • Title: externalSystemId
    The external system ID is used when exporting data containing CRM fields.
  • fields
    Title: fields
    List of fields to be included in the operation.
  • Title: filter
    The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.
  • Title: kbUsed
    The amount of space used in kilobytes. This is a read-only property.
  • Title: maxRecords
    The maximum amount of records.
  • Title: name
    The name of the export definition.
  • Title: productIdField
    The ML statement for an existing campaign field which addresses the product ID.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : fields
Type: object
Title: fields
List of fields to be included in the operation.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.
Back to Top

Response

Supported Media Types

201 Response

Success.
Body ()
Root Schema : CustomObjectExportIndividualResponse
Type: object
Title: CustomObjectExportIndividualResponse
The response body includes information about the custom object export definition.
Show Source
  • Title: areSystemTimestampsInUTC
    Whether or not system timestamps will be exported in UTC. See Filtering tutorial for an example of filtering when areSystemTimestampsInUTC is set to true.
  • Title: autoDeleteDuration
    Time until the definition will be deleted, expressed using the ISO-8601 standard.
  • Title: createdAt
    The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: createdBy
    The login id of the user who created the entity. This is a read-only property.
  • Title: crmAccountIdField
    The ML statement for an existing contact field which addresses the CRM account ID.
  • Title: dataRetentionDuration
    The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
  • Title: externalSystemId
    The external system ID is used when exporting data containing CRM fields.
  • fields
    Title: fields
    List of fields to be included in the operation.
  • Title: filter
    The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.
  • Title: kbUsed
    The amount of space used in kilobytes. This is a read-only property.
  • Title: maxRecords
    The maximum amount of records.
  • Title: name
    The name of the export definition.
  • Title: productIdField
    The ML statement for an existing campaign field which addresses the product ID.
  • syncActions
    Title: syncActions
    Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
  • Title: updatedAt
    The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
  • Title: updatedBy
    The login id of the user that last updated the entity. This is a read-only property.
  • Title: uri
    System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
Nested Schema : fields
Type: object
Title: fields
List of fields to be included in the operation.
Nested Schema : syncActions
Type: array
Title: syncActions
Specifies operations to perform during the sync with a maximum of 10 actions. See Sync actions parameters for a list of sync actions. For more information about this parameter, see the Oracle Eloqua Developer Help Center.
Show Source
Nested Schema : SyncAction
Type: object
Title: SyncAction
The definition of the action to take at time of syncronization.
Show Source
  • Title: SyncActionType
    Default Value: add
    Allowed Values: [ "add", "remove", "setStatus" ]
    The action to take at time of synchronization.
  • Title: destination
    The ML statement used to reference an object used by the action.
  • Title: MemberStatus
    Default Value: bounced
    Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]
    The status of members.
  • Title: updateAll
    Update status of all records in an execution.

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 create a new custom object export definition using an HTTP request and cURL. For more information on requests, see API requests. See the tutorial for details on how to export data.

HTTP Request Example

Create a new "Hot Air Balloon" custom object (id #9) export:


POST /customObjects/9/exports
Content-Type: application/json

Request body:


{
   "name": "Hot Air Balloon Export",
   "fields": {
	"inflated": "{{CustomObject[9].Field[99]}}",
        "ID": "{{CustomObject[9].ExternalId}}"
   }
}

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 /api/bulk/2.0/customObjects endpoint. Once you have a custom object's id #, you can retrieve its field list by using the GET /api/bulk/2.0/customObjects/{id}/fields endpoint: this will allow you to create accurate import/export definitions.

Response:


{
    "name":"Hot Air Balloon Export",
    "fields":{
        "inflated":"{{CustomObject[9].Field[99]}}",
        "ID":"{{CustomObject[9].ExternalId}}"
    },
    "dataRetentionDuration":"PT12H",
    "uri":"/customObjects/9/exports/32091",
    "createdBy":"API.User",
    "createdAt":"2015-09-14T19:45:46.2078245Z",
    "updatedBy":"API.User",
    "updatedAt":"2015-09-14T19:45:46.2078245Z"
}

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" --header "Content-Type: application/json" --request POST --data '{"name":"Hot Air Balloon Export","fields":{"inflated":"{{CustomObject[9].Field[99]}}","ID":"{{CustomObject[9].ExternalId}}"}}' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/exports

HTTP Request Example

Create a new custom object export that includes mapped contact and account fields:


POST /customObjects/9/exports
Content-Type: application/json

Request body:

Note:

Custom object exports can include any Contact or Account field, which will be returned if the exported Custom Object record is mapped to a Contact or Account. Contact or Account fields must be added with the Custom Object root. 

{
  "name": "Hot Air Balloon Export with Contact and Account Fields",
  "fields": {
    "inflated": "{{CustomObject[9].Field[99]}}",
    "ExternalId": "{{CustomObject[9].ExternalId}}",
    "ContactId": "{{CustomObject[9].Contact.Id}}",
    "ContactFirstName": "{{CustomObject[9].Contact.Field(C_FirstName)}}",
    "AccountId": "{{CustomObject[9].Account.Id}}",
    "AccountCompanyName": "{{CustomObject[9].Account.Field(M_CompanyName)}}"
  }
}

Response:


{
  "name": "Custom Object Export with Mapped fields",
  "fields": {
    "inflated": "{{CustomObject[9].Field[99]}}",
    "ExternalId": "{{CustomObject[9].ExternalId}}",
    "ContactId": "{{CustomObject[9].Contact.Id}}",
    "ContactFirstName": "{{CustomObject[9].Contact.Field(C_FirstName)}}",
    "AccountId": "{{CustomObject[9].Account.Id}}",
    "AccountCompanyName": "{{CustomObject[9].Account.Field(M_CompanyName)}}"
  },
  "dataRetentionDuration": "PT12H",
  "uri": "/customObjects/9/exports/83",
  "createdBy": "API.User",
  "createdAt": "2018-12-05T17:56:09.9810802Z",
  "updatedBy": "API.User",
  "updatedAt": "2018-12-05T17:56:09.9810802Z"
}

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" --header "Content-Type: application/json" --request POST --data '{"name":"Hot Air Balloon Export with Contact and Account Fields","fields":{"inflated":"{{CustomObject[9].Field[99]}}","ExternalId":"{{CustomObject[9].ExternalId}}","ContactId":"{{CustomObject[9].Contact.Id}}","ContactFirstName":"{{CustomObject[9].Contact.Field(C_FirstName)}}","AccountId":"{{CustomObject[9].Account.Id}}","AccountCompanyName":"{{CustomObject[9].Account.Field(M_CompanyName)}}"}}' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/exports
Back to Top