Bulk

Get the status of an async job

Reports the state of a job started by createExport. A job is queued for a moment after creation (the response carries Retry-After) and succeeded after that, at which point result_url is set. Expired jobs (older than 24 hours) return 410; start a new export.

get/api/v1/jobs/{id}

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/jobs/{id}
  • Auth: one of:
    • none
    • API key in header X-Ada-Api-Key
    • OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: catalog:read)

Path parameters

idstring required

Job id returned by createExport.

Response

The job.

object'job' required
idstring required

Opaque signed job id. Valid for 24 hours.

type'export' required
status'queued' | 'succeeded' required
progressinteger
status_urlstring uri required
result_urlstring uri nullable

Set once status is succeeded.

created_atstring date-time required
completed_atstring date-time nullable
expires_atstring date-time required
notestring

Changes

No recorded changes to this operation across all 1 revision of this API.