{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Get the status of the workflow run","type":"basic","slug":"get-the-status-of-the-workflow-run","excerpt":"","body":"This call returns the status of the workflow run. For more detailed information about the workflow run, see [Get details of a workflow run](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/{run_id}/status\",\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/40a9c1a6-9263-4982-a574-e494f7c4b621/status 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/40a9c1a6-9263-4982-a574-e494f7c4b621/status' \\\\\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'\",\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    \"0-0\": \"`run_id`\\n_required_\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the workflow run you are querying.\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\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\nThe response contains information about the status of the workflow run. The following statuses are available:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Status\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`QUEUED`\",\n    \"2-0\": \"`RUNNING`\",\n    \"1-0\": \"`INITIALIZING`\",\n    \"3-0\": \"`COMPLETE`\",\n    \"6-0\": \"`EXECUTOR_ERROR`\",\n    \"4-0\": \"`CANCELING`\",\n    \"5-0\": \"`CANCELED`\",\n    \"7-0\": \"`UNKNOWN`\",\n    \"7-1\": \"\",\n    \"0-1\": \"The task is queued. Once requested resources become available, task execution starts/resumes and task status changes to RUNNING.\",\n    \"1-1\": \"Computational resources are being initialized for this task.\",\n    \"2-1\": \"The Platform has initialized the computation instances and your task has begun executing.\",\n    \"3-1\": \"The task has ended successfully. This means the analysis has been performed without errors, and [output files have been successfully uploaded](https://sb-biodatacatalyst.readme.io/v1.0/docs/get-details-of-a-workflow-run).\",\n    \"4-1\": \"The task was canceled by the user, and is in the process of stopping.\",\n    \"5-1\": \"The task was canceled by the user.\",\n    \"6-1\": \"The task has ran into a problem during execution and did not finish successfully. You can [Get details of a workflow run](https://sb-biodatacatalyst.readme.io/v1.0/docs/get-details-of-a-workflow-run) for more information.\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]\n###Example response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"state\\\": \\\"COMPLETE\\\",\\n    \\\"run_id\\\": \\\"40a9c1a6-9263-4982-a574-e494f7c4b621\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5f8944cc5e0d25006174b5b3","createdAt":"2020-10-16T06:59:24.708Z","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}

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](doc:get-details-of-a-workflow-run). [block:code] { "codes": [ { "code": "https://cavatica-ga4gh-api.sbgenomics.com/ga4gh/wes/v1/runs/{run_id}/status", "language": "text", "name": "Path" } ] } [/block] ##Request ###Example request [block:code] { "codes": [ { "code": "GET /ga4gh/wes/v1/runs/40a9c1a6-9263-4982-a574-e494f7c4b621/status 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/40a9c1a6-9263-4982-a574-e494f7c4b621/status' \\\n--header 'X-SBG-Auth-Token: 55e9691c111146d384c5ec40a9f97fc0'", "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": { "0-0": "`run_id`\n_required_", "h-0": "Name", "h-1": "Description", "0-1": "The ID of the workflow run you are querying." }, "cols": 2, "rows": 1 } [/block] ##Response [See a list of response codes that may be contained in the body of the response.](doc:api-status-codes) The response contains information about the status of the workflow run. The following statuses are available: [block:parameters] { "data": { "h-0": "Status", "h-1": "Description", "0-0": "`QUEUED`", "2-0": "`RUNNING`", "1-0": "`INITIALIZING`", "3-0": "`COMPLETE`", "6-0": "`EXECUTOR_ERROR`", "4-0": "`CANCELING`", "5-0": "`CANCELED`", "7-0": "`UNKNOWN`", "7-1": "", "0-1": "The task is queued. Once requested resources become available, task execution starts/resumes and task status changes to RUNNING.", "1-1": "Computational resources are being initialized for this task.", "2-1": "The Platform has initialized the computation instances and your task has begun executing.", "3-1": "The task has ended successfully. This means the analysis has been performed without errors, and [output files have been successfully uploaded](https://sb-biodatacatalyst.readme.io/v1.0/docs/get-details-of-a-workflow-run).", "4-1": "The task was canceled by the user, and is in the process of stopping.", "5-1": "The task was canceled by the user.", "6-1": "The task has ran into a problem during execution and did not finish successfully. You can [Get details of a workflow run](https://sb-biodatacatalyst.readme.io/v1.0/docs/get-details-of-a-workflow-run) for more information." }, "cols": 2, "rows": 8 } [/block] ###Example response [block:code] { "codes": [ { "code": "{\n \"state\": \"COMPLETE\",\n \"run_id\": \"40a9c1a6-9263-4982-a574-e494f7c4b621\"\n}", "language": "json" } ], "sidebar": true } [/block]