Jump to

• Request
• Response
• Examples

Upload data for a custom object import definition

post

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

Uploads data for the specified custom object import definition. When uploading data, Eloqua expects that data to be encoded with UTF-8.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
• parentId(required): integer

Body ()

Root Schema : CustomObjectImportData

Type: array

Title: CustomObjectImportData

Show Source

• Array of: object CustomObjectImportDataItem
  Title: CustomObjectImportDataItem

{
    "title":"CustomObjectImportData",
    "type":"array",
    "items":{
        "title":"CustomObjectImportDataItem",
        "type":"object",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : CustomObjectImportDataItem

Type: object

Title: CustomObjectImportDataItem

Show Source

• Array of: string

{
    "title":"CustomObjectImportDataItem",
    "type":"object",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : CustomObjectImportDataResponse

Type: object

Title: CustomObjectImportDataResponse

Show Source

• callbackUrl: string
  Title: callbackUrl
• createdAt: string(date-time)
  Title: createdAt
• createdBy: string
  Title: createdBy
• status: string
  Title: SyncStatusType

  Default Value: pending

  Allowed Values: [ "pending", "active", "success", "warning", "error" ]
• syncedInstanceUri: string
  Title: syncedInstanceUri
• syncEndedAt: string(date-time)
  Title: syncEndedAt
• syncStartedAt: string(date-time)
  Title: syncStartedAt
• uri: string
  Title: uri

{
    "title":"CustomObjectImportDataResponse",
    "description":"",
    "properties":{
        "callbackUrl":{
            "title":"callbackUrl",
            "description":"",
            "type":"string"
        },
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"",
            "type":"string"
        },
        "status":{
            "$ref":"#/definitions/SyncStatusType"
        },
        "syncedInstanceUri":{
            "title":"syncedInstanceUri",
            "description":"",
            "type":"string"
        },
        "syncEndedAt":{
            "format":"date-time",
            "title":"syncEndedAt",
            "description":"",
            "type":"string"
        },
        "syncStartedAt":{
            "format":"date-time",
            "title":"syncStartedAt",
            "description":"",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"",
            "type":"string"
        }
    }
}

204 Response

No content.

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

HTTP Request Example

Upload data for import definition with the id #32082 (under the custom object with id #9):

POST /customObjects/9/imports/32082/data
Content-Type: application/json 
			

Request body:

[
   {
      "ID": "1",
      "Inflated": "yes"
   },
   {
      "ID": "2",
      "Inflated": "no"
   },
   {
      "ID": "3",
      "Inflated": "yes"
   }
]
			

Note:

The format of the above information depends on which fields are entered into the import definition. Learn more about Bulk API imports.

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:

204 No Content
			

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 '[{"ID":"1","Inflated":"yes"},{"ID":"2","Inflated":"no"},{"ID":"3","Inflated":"yes"}]' https://secure.p03.eloqua.com/api/bulk/2.0/customObjects/9/imports/32082/data
			

Back to Top