RTrtxteam
asyncquery_status

Retrieve the current status of a previously submitted asyncquery given its job_id

get/asyncquery_status/{job_id}

Request

Path parameters

job_idstring required

Identifier of the job for status request

Response

Returns the status and current logs of a previously submitted asyncquery.

statusstring required

One of a standardized set of short codes: Queued, Running, Completed, Failed

descriptionstring required

A brief human-readable description of the current state or summary of the problem if the status is Failed.

response_urlstring nullable

Optional URL that can be queried to restrieve the full TRAPI Response.

Example response

{
  "description": "Callback URL returned 500",
  "logs": [
    {
      "code": "code",
      "level": "",
      "message": "message",
      "timestamp": "2020-09-03T18:13:49Z"
    },
    {
      "code": "code",
      "level": "",
      "message": "message",
      "timestamp": "2020-09-03T18:13:49Z"
    }
  ],
  "status": "Running",
  "response_url": "https://arax.ncats.io/api/arax/v1.3/response/116481"
}

Changes

No recorded changes to this operation across all 27 revisions of this API.