Check asynchronous job status
Read an asynchronous job by its ID. This endpoint returns the AsyncJob resource and indicates whether the job is still running or has finished. Bulk export requests use the separate bulk export status endpoint to retrieve their output manifest.
| Method | Path |
|---|---|
GET | /fhir/R4/job/:id/status |
Request
curl --include \
--url "https://api.sandbox.ovok.com/fhir/R4/job/${JOB_ID}/status" \
--header "Authorization: Bearer ${OVOK_TOKEN}"
| Path value | Description |
|---|---|
:id | ID of the AsyncJob resource returned by the asynchronous operation. |
Response
The body is a FHIR AsyncJob resource. The HTTP status distinguishes an unfinished job from a completed or failed one.
| HTTP status | Job status | Meaning |
|---|---|---|
202 Accepted | accepted or active | Job is queued or running. Poll this URL again. |
200 OK | completed | Job finished successfully. |
200 OK | error | Job finished with an error; inspect the resource's error/output details. |
AsyncJob field | Description |
|---|---|
id | Job identifier. |
request | Original request or operation URL. |
status | Current lifecycle status. |
requestTime | Time the job was created. |
output | Job result when available. |
The route may return an authorization or not-found error if the job is not visible to the caller.