List workflow runs

Suggest Edits

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

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

Request

Example request

GET /ga4gh/wes/v1/runs HTTP/1.1
Host: cgc-ga4gh-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9314fa9d9273156740f66

curl --location --request GET 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs' \
--header 'X-SBG-Auth-Token: 3210a98c1db9314fa9d9273156740f66' \

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": "40a284d3-c1de-401c-8799-3de8d85bbd8d"
        },
        {
            "state": "COMPLETE",
            "run_id": "30a284d3-c1de-401c-8799-3de8d85bbd8d"
        },
        {
            "state": "COMPLETE",
            "run_id": "20a284d3-c1de-401c-8799-3de8d85bbd8d"
        },
        {
            "state": "COMPLETE",
            "run_id": "140a284d3-c1de-401c-8799-3de8d85bbd8d"
        },
        {
            "state": "COMPLETE",
            "run_id": "00a284d3-c1de-401c-8799-3de8d85bbd8d"
        }],
     "next_page_token": ""
}

Updated about 3 years ago