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
The import definition???s resource identification number.
-
parentId(required): integer
The custom object's resource identification number.
The request body contains data to be uploaded to the custom object import definition.
Root Schema : CustomObjectImportData
Type:
arrayTitle:
Show Source
CustomObjectImportData-
Array of:
object CustomObjectImportDataItem
Title:
CustomObjectImportDataItem
Nested Schema : CustomObjectImportDataItem
Type:
objectTitle:
Show Source
CustomObjectImportDataItemResponse
Supported Media Types
- application/json
201 Response
Success.
Root Schema : CustomObjectImportDataResponse
Type:
objectTitle:
CustomObjectImportDataResponseSync response when POSTing custom object import data, and isSyncTriggeredOnImport = true on the import definition.
Show Source
-
callbackUrl:
string
Title:
callbackUrlWhen a sync completes, Eloqua will make a call to the URL specified in this parameter. The callback can occur during sync creation, before the sync creation response, or immediately after. -
createdAt:
string(date-time)
Title:
createdAtThe date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property. -
createdBy:
string
Title:
createdByThe login id of the user who created the entity. This is a read-only property. -
status:
string
Title:
SyncStatusTypeDefault Value:pendingAllowed Values:[ "pending", "active", "success", "warning", "error" ]The status of the synchronization. This is a read-only property. -
syncedInstanceUri:
string
Title:
syncedInstanceUriThis value should be the uri for the export/import definition you wish to sync. When you create an import/export definition, Eloqua will respond with a "uri" parameter, the value of which should be used here. -
syncEndedAt:
string(date-time)
Title:
syncEndedAtThe date and time the sync ended. This is a read-only property. -
syncStartedAt:
string(date-time)
Title:
syncStartedAtThe date and time the sync started. This is a read-only property. -
uri:
string
Title:
uriSystem-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
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.
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 theGET /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