{"_id":"57321600c7e5a51700f985bf","project":"55faeacad0e22017005b8265","version":{"_id":"55faeacad0e22017005b8268","project":"55faeacad0e22017005b8265","__v":35,"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","59e76ce41938310028037295","5a009de510890d001c2aabfe"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"v1","version_clean":"1.0.0","version":"1"},"user":"55fae9d4825d5f19001fa379","__v":11,"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":9,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-05-10T17:10:24.738Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"owner\": \"username\",\n  \"batch_workflow_id\": \"4346139242736357640\",\n  \"workflow_name\": \"fastortho_stagetos3\",\n  \"submitted_time\": \"2016-06-01T17:42:51.415894+00:00\",\n  \"workflows\": [\n    {\n      \"workflow_id\": \"4346139242751065655\",\n      \"state\": \"submitted\"\n    },\n    {\n      \"workflow_id\": \"4346139242764152386\",\n      \"state\": \"submitted\"\n    },\n    {\n      \"workflow_id\": \"4346139242780426784\",\n      \"state\": \"submitted\"\n    }\n  ]\n}","language":"json","status":200}]},"settings":"56143e6a1a8caf0d00689482","examples":{"codes":[{"code":"{\n       \"name\": \"batch_test\",\n       \"batch_values\": [\n           {\n               \"name\": \"input_data\",\n               \"values\": [\n                   \"CAT1\",\n                   \"CAT2\",\n                   \"CAT3\"\n               ]\n           },\n           {\n               \"name\": \"input_dem\",\n               \"values\": [\n                   \"SRTM90\",\n                   \"SRTM120\",\n                   \"SRTM150\"\n               ]\n           },\n           {\n               \"name\": \"destination\",\n               \"values\": [\n                   \"result/1\",\n                   \"result/2\",\n                   \"result/3\"\n               ]\n           }\n       ],\n       \"tasks\": [\n           {\n               \"name\": \"task_1\",\n               \"outputs\": [\n                   {\n                       \"name\": \"data\",\n                       \"persist\": true,\n                       \"persistLocation\": \"{{destination}}\"\"\n                   }\n               ],\n               \"inputs\": [\n                   {\n                       \"name\": \"data\",\n                       \"value\": \"{{input_data}}\"\n                   },\n                   {\n                       \"name\": \"demspecifier\",\n                       \"value\": \"{{input_dem}}\"\n                   }\n               ],\n               \"taskType\": \"test_task\"\n           }\n       ]\n    }","language":"json"}]},"method":"post","auth":"required","params":[],"url":"/workflows/v1/batch_workflows"},"isReference":false,"order":21,"body":"Batch Workflow request elements\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"element\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"name\",\n    \"0-1\": \"string\",\n    \"0-2\": \"user provided workflow name\",\n    \"1-0\": \"batch values\",\n    \"1-1\": \"\",\n    \"1-2\": \"input name and batch values for the input\",\n    \"2-0\": \"name\",\n    \"2-1\": \"string\",\n    \"2-2\": \"name of the input port.\",\n    \"3-0\": \"values\",\n    \"3-2\": \"input values for the named input port\",\n    \"4-0\": \"tasks\",\n    \"4-2\": \"a list of tasks and their input and output values that will run in this workflow\",\n    \"5-0\": \"name\",\n    \"5-1\": \"string\",\n    \"5-2\": \"name of the task. This can be a user provided name. Does not have to match name in task definition\",\n    \"6-0\": \"outputs\",\n    \"6-2\": \"the output from the task. Commonly named \\\"data\\\"\",\n    \"7-0\": \"name\",\n    \"7-2\": \"user provided name of the output\",\n    \"9-0\": \"name\",\n    \"8-0\": \"inputs\",\n    \"8-2\": \"list of inputs for the task\",\n    \"7-1\": \"string\",\n    \"9-1\": \"string\",\n    \"9-2\": \"user provided name of the output\",\n    \"10-0\": \"value\",\n    \"10-1\": \"string\",\n    \"10-2\": \"$ indicates a batch value. The name used here needs to match the name used in the workflow batch values list \\n\\nExample: \\n \\\"name\\\": \\\"input_data\\\",\\n$batch_value:input_data\\\"\",\n    \"11-0\": \"taskType\",\n    \"11-1\": \"string\",\n    \"11-2\": \"This is the name of the task as it is registered in the task registry. It must be identical. For example, if running the task \\\"AComp_0.23.2.1\\\", the task type must be \\\"AComp_0.23.2.1\\\"\",\n    \"3-1\": \"string\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Submit a batch workflow that spawns multiple workflows.","slug":"submit-a-batch-workflow","type":"endpoint","title":"Submit a batch workflow"}

postSubmit a batch workflow

Submit a batch workflow that spawns multiple workflows.

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Batch Workflow request elements [block:parameters] { "data": { "h-0": "element", "h-1": "type", "h-2": "description", "0-0": "name", "0-1": "string", "0-2": "user provided workflow name", "1-0": "batch values", "1-1": "", "1-2": "input name and batch values for the input", "2-0": "name", "2-1": "string", "2-2": "name of the input port.", "3-0": "values", "3-2": "input values for the named input port", "4-0": "tasks", "4-2": "a list of tasks and their input and output values that will run in this workflow", "5-0": "name", "5-1": "string", "5-2": "name of the task. This can be a user provided name. Does not have to match name in task definition", "6-0": "outputs", "6-2": "the output from the task. Commonly named \"data\"", "7-0": "name", "7-2": "user provided name of the output", "9-0": "name", "8-0": "inputs", "8-2": "list of inputs for the task", "7-1": "string", "9-1": "string", "9-2": "user provided name of the output", "10-0": "value", "10-1": "string", "10-2": "$ indicates a batch value. The name used here needs to match the name used in the workflow batch values list \n\nExample: \n \"name\": \"input_data\",\n$batch_value:input_data\"", "11-0": "taskType", "11-1": "string", "11-2": "This is the name of the task as it is registered in the task registry. It must be identical. For example, if running the task \"AComp_0.23.2.1\", the task type must be \"AComp_0.23.2.1\"", "3-1": "string" }, "cols": 3, "rows": 12 } [/block]

User Information

Try It Out


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