Bulk requests

Use the bulk service to send multiple operations for one REST object for asynchronous processing. See the Bulk requests topic for more details.

Send a bulk request

post/services/bulk/job/create

Send a bulk request for asynchronous processing.

SecurityOAuth2
Request
Request Body schema: application/json
required
objectName
required
string

The name of the REST object targeted by the request.

Example: "vendor"
operation
required
string

The HTTP operation for the request.

Enum: "create" "delete" "update"
Example: "create"
jobFile
required
string <inbound-binary>

The name for the input file.

Example: "vendor.csv"
fileContentType
required
string

The format for the input file.

Value: "json"
Example: "json"
callbackURL
string or null

Callback URL for receiving the asynchronous response.

Example: "https://example.com/callback"
Responses
200

OK

400

Bad Request

Request samples
application/json
{
  • "objectName": "vendor",
  • "operation": "create",
  • "jobFile": "vendor.csv",
  • "fileContentType": "json",
  • "callbackURL": "https://example.com/callback"
}
Response samples
application/json
{
  • "ia::result": {
    • "jobId": "950bf10d-f119-41c9-a352-1b68b34498c3",
    • "statusURL": "/services/bulk/job/status?jobId=950bf10d-f119-41c9-a352-1b68b34498c3",
    • "createdDateTime": "2023-08-01T01:20:30"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}