batch-jobs

Batch jobs allow for asynchronous processing of long-running operations. Poll the batch job endpoint to check status and retrieve results when complete

Get Batch Job by ID

Get the status of a batch job by ID.

The response includes:

  • status: Current job status (queued, processing, completed, failed)
  • lastUpdatedDateTime: When the status was last updated
  • retryAfterSeconds: Recommended polling interval (only when status is processing)
  • location: Result resource URL (only when status is completed)
SecuritybearerAuth
Request
path Parameters
jobId
required
string <uuid>

Batch Job ID

Example: c9f53621-86c3-4e5a-97f7-56165388cf410
Responses
200

Batch Job Response

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

default

General Error

get/batch-jobs/{jobId}
Request samples
Response samples
application/vnd.api+json
{}