{"_id":"573216d44245100e001746cc","__v":7,"parentDoc":null,"project":"55faeacad0e22017005b8265","user":"55fae9d4825d5f19001fa379","category":{"_id":"5601aee850ee460d0002224c","__v":20,"project":"55faeacad0e22017005b8265","version":"55faeacad0e22017005b8268","pages":["56023786930fe1170074bd2c","561d53a09463520d00cd11ef","561d546d31d9630d001eb5d1","561d54af31d9630d001eb5d3","561d54e56386060d00e0601e","561d554d9463520d00cd11f2","564246059f4ed50d008be1af","5643712a0d9748190079defb","564372751ecf381700343c1e","5643742008894c0d00031ed3","5643747a0d9748190079df01","564375c988f3a60d00ac86b0","56437d0f0d9748190079df13","56437e83f49bfa0d002f560a","56437f7d0d9748190079df15","5643810508894c0d00031ef5","5643826f88f3a60d00ac86cb","564382de88f3a60d00ac86ce","56e07ba14685db1700d94873","56e08c9b903c7a29001d5352"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-22T19:41:28.703Z","from_sync":false,"order":8,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":33,"createdAt":"2015-09-17T16:31:06.800Z","releaseDate":"2015-09-17T16:31:06.800Z","categories":["55faeacbd0e22017005b8269","55faf550764f50210095078e","55faf5b5626c341700fd9e96","55faf8a7825d5f19001fa386","560052f91503430d007cc88f","560054f73aa0520d00da0b1a","56005aaf6932a00d00ba7c62","56005c273aa0520d00da0b3f","5601ae7681a9670d006d164d","5601ae926811d00d00ceb487","5601aeb064866b1900f4768d","5601aee850ee460d0002224c","5601afa02499c119000faf19","5601afd381a9670d006d1652","561d4c78281aec0d00eb27b6","561d588d8ca8b90d00210219","563a5f934cc3621900ac278c","5665c5763889610d0008a29e","566710a36819320d000c2e93","56ddf6df8a5ae10e008e3926","56e1c96b2506700e00de6e83","56e1ccc4e416450e00b9e48c","56e1ccdfe63f910e00e59870","56e1cd10bc46be0e002af26a","56e1cd21e416450e00b9e48e","56e3139a51857d0e008e77be","573b4f62ef164e2900a2b881","57c9d1335fd8ca0e006308ed","57e2bd9d1e7b7220000d7fa5","57f2b992ac30911900c7c2b6","58adb5c275df0f1b001ed59b","58c81b5c6dc7140f003c3c46","595412446ed4d9001b3e7b37"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"updates":["57d07bd7440f87170038f95f"],"next":{"pages":[],"description":""},"createdAt":"2016-05-10T17:13:56.102Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n    \"owner\": \"myUserName\",\n    \"batch_workflow_id\": \"4320822787474689603\",\n    \"workflow_name\": \"AOP_Strip_Processor_stagetos3\",\n    \"submitted_time\": \"2016-04-27T19:23:34.770011+00:00\",\n    \"workflows\": [\n        {\n            \"workflow_id\": \"4320822787507746157\",\n            \"state\": \"submitted\"\n        },\n        {\n            \"workflow_id\": \"4320822787515379476\",\n            \"state\": \"submitted\"\n        },\n        {\n            \"workflow_id\": \"4320822787522659702\",\n            \"state\": \"submitted\"\n        }\n    ]\n}","language":"json","status":200}]},"settings":"5601fdaa1ba3720d00a6b981","examples":{"codes":[{"code":"","language":"json"}]},"auth":"required","params":[],"url":"/workflows/v1/batch_workflows/<batch_workflow_id>"},"isReference":false,"order":22,"body":"The \"Get a batch workflow\" request lets you see the state of each workflow in the batch. \n\nA batch workflow does not have events or states. Each workflow in the batch has its own state. Submitting a batch workflow kicks off all workflows in the batch in parallel.\n\n#### Workflow States\n\n\t* submitted\n\t* scheduled\n\t* started\n\t* canceled\n\t* cancelling\n\t* failed\n\t* succeeded\n\t* timedout\n\t* pending\n\t* running\n\t* complete\n\t* all","excerpt":"Get a batch workflow by ID.","slug":"get-a-batch-workflow","type":"endpoint","title":"Get a batch workflow"}

getGet a batch workflow

Get a batch workflow by ID.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

The "Get a batch workflow" request lets you see the state of each workflow in the batch. A batch workflow does not have events or states. Each workflow in the batch has its own state. Submitting a batch workflow kicks off all workflows in the batch in parallel. #### Workflow States * submitted * scheduled * started * canceled * cancelling * failed * succeeded * timedout * pending * running * complete * all

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}