Jump to

• Request
• Response
• Examples

Retrieve the specified export definition for a custom object

get

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

Retrieves the specified export definition for the specified custom object.

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : CustomObjectExportIndividualResponse

Type: object

Title: CustomObjectExportIndividualResponse

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

Show Source

• areSystemTimestampsInUTC: boolean
  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.
• autoDeleteDuration: string
  Title: autoDeleteDuration

  Time until the definition will be deleted, expressed using the ISO-8601 standard.
• createdAt: string(date-time)
  Title: createdAt

  The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
• createdBy: string
  Title: createdBy

  The login id of the user who created the entity. This is a read-only property.
• crmAccountIdField: string
  Title: crmAccountIdField

  The ML statement for an existing contact field which addresses the CRM account ID.
• dataRetentionDuration: string
  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.
• externalSystemId: integer
  Title: externalSystemId

  The external system ID is used when exporting data containing CRM fields.
• fields: object fields
  Title: fields

  List of fields to be included in the operation.
• filter: string
  Title: filter

  The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about filters.
• kbUsed: integer(int64)
  Title: kbUsed

  The amount of space used in kilobytes. This is a read-only property.
• maxRecords: integer
  Title: maxRecords

  The maximum amount of records.
• name: string
  Title: name

  The name of the export definition.
• productIdField: string
  Title: productIdField

  The ML statement for an existing campaign field which addresses the product ID.
• syncActions: array 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.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the entity. This is a read-only property.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.

{
    "title":"CustomObjectExportIndividualResponse",
    "description":"The response body includes information about the custom object export definition.",
    "properties":{
        "areSystemTimestampsInUTC":{
            "title":"areSystemTimestampsInUTC",
            "description":"Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.",
            "type":"boolean"
        },
        "autoDeleteDuration":{
            "title":"autoDeleteDuration",
            "description":"Time until the definition will be deleted, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity. This is a read-only property.",
            "type":"string"
        },
        "crmAccountIdField":{
            "title":"crmAccountIdField",
            "description":"The ML statement for an existing contact field which addresses the CRM account ID.",
            "type":"string"
        },
        "dataRetentionDuration":{
            "title":"dataRetentionDuration",
            "description":"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.",
            "type":"string"
        },
        "externalSystemId":{
            "title":"externalSystemId",
            "description":"The external system ID is used when exporting data containing CRM fields.",
            "type":"integer"
        },
        "fields":{
            "title":"fields",
            "description":"List of fields to be included in the operation.",
            "type":"object"
        },
        "filter":{
            "title":"filter",
            "description":"The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.",
            "type":"string"
        },
        "kbUsed":{
            "format":"int64",
            "title":"kbUsed",
            "description":"The amount of space used in kilobytes. This is a read-only property.",
            "type":"integer"
        },
        "maxRecords":{
            "title":"maxRecords",
            "description":"The maximum amount of records.",
            "type":"integer"
        },
        "name":{
            "title":"name",
            "description":"The name of the export definition.",
            "type":"string"
        },
        "productIdField":{
            "title":"productIdField",
            "description":"The ML statement for an existing campaign field which addresses the product ID.",
            "type":"string"
        },
        "syncActions":{
            "title":"syncActions",
            "description":"Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SyncAction"
            }
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity. This is a read-only property.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.",
            "type":"string"
        }
    }
}

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

• Array of: object SyncAction
  Title: SyncAction

  The definition of the action to take at time of syncronization.

{
    "title":"syncActions",
    "description":"Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SyncAction"
    }
}

Nested Schema : SyncAction

Type: object

Title: SyncAction

The definition of the action to take at time of syncronization.

Show Source

• action: string
  Title: SyncActionType

  Default Value: add

  Allowed Values: [ "add", "remove", "setStatus" ]

  The action to take at time of synchronization.
• destination: string
  Title: destination

  The ML statement used to reference an object used by the action.
• status: string
  Title: MemberStatus

  Default Value: bounced

  Allowed Values: [ "bounced", "subscribed", "unsubscribed", "active", "complete", "pending", "errored", "yes", "no", "invalid", "permission" ]

  The status of members.
• updateAll: boolean
  Title: updateAll

  Update status of all records in an execution.

{
    "title":"SyncAction",
    "description":"The definition of the action to take at time of syncronization.",
    "properties":{
        "action":{
            "$ref":"#/definitions/SyncActionType"
        },
        "destination":{
            "title":"destination",
            "description":"The ML statement used to reference an object used by the action.",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/MemberStatus"
        },
        "updateAll":{
            "title":"updateAll",
            "description":"Update status of all records in an execution.",
            "type":"boolean"
        }
    }
}

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 an export definition for a custom object using an HTTP request and cURL. For more information on requests, see API requests.

HTTP Request Example

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

GET /customObjects/9/exports/32091 
			

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:

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

    ],
    "dataRetentionDuration":"PT12H",
    "uri":"/customObjects/9/exports/32091",
    "createdBy":"API.User",
    "createdAt":"2015-09-14T19:45:46.2070000Z",
    "updatedBy":"API.User",
    "updatedAt":"2015-09-14T19:45:46.2070000Z"
}
			

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 
			

Back to Top