List workflow runs

This call returns a list of workflow runs that you can access. To monitor a specific workflow run, use GetRunStatus or GetRunLog.

https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs

Request

Example request

GET /ga4gh/wes/v1/runs 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' \
--header 'X-SBG-Auth-Token: 55e9691c111146d383c5ec40a9f97fc0' \

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your authentication token.

Path parameters

Name

Data type

Description

page_size

string

Specify the preferred number of workflow runs to return in a page. If unspecified, the default value will be used. The default value is 50. The availability of additional pages is indicated by the value of next_page_token in the response.

page_token

string

Specify page token to indicate where to start getting results. If unspecified, the first page of results will be returned.

Response

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

Response body

Name

Data type

Decription

runs

Array of objects (RunStatus)

A list of workflow runs that the service has executed or is executing. The list is filtered to only include runs that the caller has permission to see.

next_page_token

string

A token which may be supplied as page_token in workflow run list request to get the next page of results. An empty string indicates there are no more items to return.

Example response body

{
    "runs": [
        {
            "state": "COMPLETE",
            "run_id": "068a172d-92f8-41ef-b43d-3f0ab612ced1"
        },
        {
            "state": "COMPLETE",
            "run_id": "3f165bc2-af1e-47ec-be3a-9ef216deb2b7"
        },
        {
            "state": "COMPLETE",
            "run_id": "f4d905e6-0c33-41d9-ad0f-04e46a973fcc"
        },
        {
            "state": "COMPLETE",
            "run_id": "4553960c-d6c1-4c65-a3fb-acdd2d6e8719"
        },
        {
            "state": "COMPLETE",
            "run_id": "099e8bcf-1685-4ca4-8a7b-33de34b1837e"
        }],
     "next_page_token": ""
}