{"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://cgc-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: cgc-ga4gh-api.sbgenomics.com\\nX-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74\",\n \"language\": \"http\",\n \"name\": null\n },\n {\n \"code\": \"curl --location --request GET 'https://cgc-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs' \\\\\\n--header 'X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74' \\\\\",\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\\\": \\\"144a9a82-44b6-5d77-a35b-92b0429ecc38\\\"\\n },\\n {\\n \\\"state\\\": \\\"COMPLETE\\\",\\n \\\"run_id\\\": \\\"ef849280-c0a7-53ff-9aa8-20cb8fda9aa4\\\"\\n },\\n {\\n \\\"state\\\": \\\"COMPLETE\\\",\\n \\\"run_id\\\": \\\"f4d905e6-1e44-41d9-ad0f-04e46a973fcc\\\"\\n },\\n {\\n \\\"state\\\": \\\"COMPLETE\\\",\\n \\\"run_id\\\": \\\"4553960c-ae6c-4c65-a3fb-acdd2d6e8719\\\"\\n },\\n {\\n \\\"state\\\": \\\"COMPLETE\\\",\\n \\\"run_id\\\": \\\"213aedd-1685-4ca4-8a7b-22de34b1837e\\\"\\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":"5f89524c72777a005945cc33","createdAt":"2020-10-16T07:57:00.369Z","user":"566590c83889610d0008a253","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"WES API","slug":"wes-api","order":40,"from_sync":false,"reference":false,"_id":"5f894c7d3b0894006477ca01","createdAt":"2020-10-16T07:32:13.051Z","version":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":0},"version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4","5f894c7d3b0894006477ca01","6176d5bf8f59c6001038c2f7"],"_id":"55faf11ba62ba1170021a9aa","releaseDate":"2015-09-17T16:58:03.490Z","createdAt":"2015-09-17T16:58:03.490Z","project":"55faf11ba62ba1170021a9a7","__v":48},"project":"55faf11ba62ba1170021a9a7","__v":0,"parentDoc":null}