{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"List workflow runs","type":"basic","slug":"list-workflow-runs","excerpt":"","body":"This call returns a list of workflow runs that you can access. To monitor a specific workflow run, use [GetRunStatus](doc:get-the-status-of-the-workflow-run) or [GetRunLog](doc:get-details-of-a-workflow-run).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /ga4gh/wes/v1/runs HTTP/1.1\\nHost: cavatica-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs' \\\\\\n--header 'X-SBG-Auth-Token: 55e9691c111146d383c5ec40a9f97fc0' \\\\\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"0-0\": \"`page_size`\",\n    \"1-0\": \"`page_token`\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"0-2\": \"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.\",\n    \"1-2\": \"Specify page token to indicate where to start getting results. If unspecified, the first page of results will be returned.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n##Response\n\n[See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Response body\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Decription\",\n    \"0-0\": \"`runs`\",\n    \"0-1\": \"Array of objects ([RunStatus](doc:get-the-status-of-the-workflow-run))\",\n    \"0-2\": \"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.\",\n    \"1-0\": \"`next_page_token`\",\n    \"1-1\": \"string\",\n    \"1-2\": \"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.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"runs\\\": [\\n        {\\n            \\\"state\\\": \\\"COMPLETE\\\",\\n            \\\"run_id\\\": \\\"068a172d-92f8-41ef-b43d-3f0ab612ced1\\\"\\n        },\\n        {\\n            \\\"state\\\": \\\"COMPLETE\\\",\\n            \\\"run_id\\\": \\\"3f165bc2-af1e-47ec-be3a-9ef216deb2b7\\\"\\n        },\\n        {\\n            \\\"state\\\": \\\"COMPLETE\\\",\\n            \\\"run_id\\\": \\\"f4d905e6-0c33-41d9-ad0f-04e46a973fcc\\\"\\n        },\\n        {\\n            \\\"state\\\": \\\"COMPLETE\\\",\\n            \\\"run_id\\\": \\\"4553960c-d6c1-4c65-a3fb-acdd2d6e8719\\\"\\n        },\\n        {\\n            \\\"state\\\": \\\"COMPLETE\\\",\\n            \\\"run_id\\\": \\\"099e8bcf-1685-4ca4-8a7b-33de34b1837e\\\"\\n        }],\\n     \\\"next_page_token\\\": \\\"\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f89459fd8d19e00116d7757","createdAt":"2020-10-16T07:02:55.127Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":25,"from_sync":false,"reference":false,"_id":"5f893e508c9862002d0614a9","createdAt":"2020-10-16T06:31:44.321Z","version":"5773dcfc255e820e00e1cd50","project":"5773dcfc255e820e00e1cd4d","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9"],"_id":"5773dcfc255e820e00e1cd50","__v":35,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"project":"5773dcfc255e820e00e1cd4d","__v":0,"parentDoc":null}

List workflow runs


This call returns a list of workflow runs that you can access. To monitor a specific workflow run, use [GetRunStatus](doc:get-the-status-of-the-workflow-run) or [GetRunLog](doc:get-details-of-a-workflow-run). [block:code] { "codes": [ { "code": "https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /ga4gh/wes/v1/runs HTTP/1.1\nHost: cavatica-ga4gh-api.sbgenomics.com\nX-SBG-Auth-Token: 55e9691c111146bd384c5ec40a9f97fb1\n", "language": "http", "name": null }, { "code": "curl --location --request GET 'https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs' \\\n--header 'X-SBG-Auth-Token: 55e9691c111146d383c5ec40a9f97fc0' \\", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your [authentication token](doc:get-your-authentication-token).", "h-2": "" }, "cols": 2, "rows": 1 } [/block] ###Path parameters [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "0-0": "`page_size`", "1-0": "`page_token`", "h-2": "Description", "0-1": "string", "1-1": "string", "0-2": "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.", "1-2": "Specify page token to indicate where to start getting results. If unspecified, the first page of results will be returned." }, "cols": 3, "rows": 2 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) ###Response body [block:parameters] { "data": { "h-0": "Name", "h-1": "Data type", "h-2": "Decription", "0-0": "`runs`", "0-1": "Array of objects ([RunStatus](doc:get-the-status-of-the-workflow-run))", "0-2": "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.", "1-0": "`next_page_token`", "1-1": "string", "1-2": "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." }, "cols": 3, "rows": 2 } [/block] ###Example response body [block:code] { "codes": [ { "code": "{\n \"runs\": [\n {\n \"state\": \"COMPLETE\",\n \"run_id\": \"068a172d-92f8-41ef-b43d-3f0ab612ced1\"\n },\n {\n \"state\": \"COMPLETE\",\n \"run_id\": \"3f165bc2-af1e-47ec-be3a-9ef216deb2b7\"\n },\n {\n \"state\": \"COMPLETE\",\n \"run_id\": \"f4d905e6-0c33-41d9-ad0f-04e46a973fcc\"\n },\n {\n \"state\": \"COMPLETE\",\n \"run_id\": \"4553960c-d6c1-4c65-a3fb-acdd2d6e8719\"\n },\n {\n \"state\": \"COMPLETE\",\n \"run_id\": \"099e8bcf-1685-4ca4-8a7b-33de34b1837e\"\n }],\n \"next_page_token\": \"\"\n}", "language": "json" } ], "sidebar": true } [/block]