Query Run Status

POST /api/v1/queryrunstatus

Required Headers

Authorization: Bearer <token>

Body

Submit a single JSON encoded QueryJobRunStatusBody as the POST body.

Returns

HTTP 200 on success

HTTP 400 on malformed query (do not resubmit without fixes)

HTTP 401 on invalid/missing Authorization token (do not resubmit without updating Authorization)

HTTP 5XX on an error internal to DES.

On failure the response body will be a single JSON encoded ErrorResponse

On success the response body will be a single JSON encoded QueryJobRunStatusResponse.

Remarks

The finished property will be the primary way to determined whether the job run has finished its execution or not.

The outputFiles property will only be populated if the jobRun has finished successfully. These will only contain metadata about the files as they have been stored. To download the contents of these files you will need to utilise the GetRunFiles endpoint. The output files will depend on the template associated with the parent Job.