Maintenance

Get the status of an async job

Get the status of a previously scheduled asynchronous job

If a job is cancelled, simply retrying the request won't help. You might need to make changes to Document Engine's configuration and restart your Document Engine instances. For example, a cancellation could occur if you attempted an asset migration job to a storage backend that's not enabled in your Document Engine configuration.

If a job is expired, then the job as well as its output assets (PDFs, images etc.) - if any, will have been deleted and thus be unavailable for download. Attempts to check the status of that job return a 404 not found error. You need to redo an expired job to regenerate those assets. You can configure the expiration time for jobs by setting the ASYNC_JOBS_TTL option in the Document Engine configuration. The default value is 2 days.

get/api/async/jobs/{jobId}

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/async/jobs/{jobId}
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

jobIdstring required

The async job ID

Response

The job status was successfully retrieved.

Changes

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