Get the status of the workflow run

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://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/status

Request

Example request

GET /ga4gh/wes/v1/runs/40a9c1a6-9263-4982-a574-e494f7c4b621/status HTTP/1.1
Host: cavatica-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1
curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/40a9c1a6-9263-4982-a574-e494f7c4b621/status' \
--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'

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": "40a9c1a6-9263-4982-a574-e494f7c4b621"
}