Bulk status requests

Use the bulk status service to monitor the status of a bulk request.

Get a bulk request status

get/services/bulk/job/status

Monitor the status of a bulk request.

SecurityOAuth2
Request
query Parameters
jobId
required
string

Unique identifier for the bulk request.

Example: jobId=950bf10d-f119-41c9-a352-1b68b34498c3
download
boolean

After the bulk request has completed (status field is set to completed), set to trueto download the response file which contains the results of all the operations in JSON format.

Example: download=true
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "jobId": "950bf10d-f119-41c9-a352-1b68b34498c3",
    • "status": "completed",
    • "percentComplete": 100,
    • "downloadURL": "/services/bulk/job/status?jobId=950bf10d-f119-41c9-a352-1b68b34498c3&download=true",
    • "jobStatusFile": "950bf10d-f119-41c9-a352-1b68b34498c3-response.json"
    },
  • "ia::meta": {
    • "totalCount": 3,
    • "totalSuccess": 2,
    • "totalError": 1
    }
}
Feedback