Get the status of the workflow run

Suggest Edits

This call returns the status of the workflow run. For more detailed information about the workflow run, see Get details of a workflow run.

https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/status

Request

Example request

GET /ga4gh/wes/v1/runs/48f79ccf-12b3-45b6-789c-b1e8d88dabcd/status HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl --location --request GET 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/5a4c3582-cbe1-5ba4-8945-af338969c510/status' \
--header 'X-SBG-Auth-Token: 3210a98c1db9304ea9d9873156740f74'

Header Fields

Name	Description
`X-SBG-Auth-Token` required	Your authentication token.

Path parameters

Name	Description
`run_id` required	The ID of the workflow run you are querying.

Response

See a list of response codes that may be contained in the body of the response.

The response contains information about the status of the workflow run. The following statuses are available:

Status	Description
`QUEUED`	The task is queued. Once requested resources become available, task execution starts/resumes and task status changes to RUNNING.
`INITIALIZING`	Computational resources are being initialized for this task.
`RUNNING`	The Platform has initialized the computation instances and your task has begun executing.
`COMPLETE`	The task has ended successfully. This means the analysis has been performed without errors, and output files have been successfully uploaded.
`CANCELING`	The task was canceled by the user, and is in the process of stopping.
`CANCELED`	The task was canceled by the user.
`EXECUTOR_ERROR`	The task has ran into a problem during execution and did not finish successfully. You can Get details of a workflow run for more information.
`UNKNOWN`

Example response

{
    "state": "COMPLETE",
    "run_id": "e3ed2ce1-8f8c-14a9-bd71-4cebd2ee441f"
}

Updated about 2 years ago