{"_id":"564382de88f3a60d00ac86ce","__v":8,"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":9,"slug":"tasks-and-workflows-guide","title":"Tasks and Workflows Guide"},"parentDoc":null,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-11T18:03:10.302Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{\n  \"definitions\": {\n    \"OutPort\": {\n      \"$ref\": \"#/definitions/Port\"\n    },\n    \"Task\": {\n      \"required\": [\n        \"name\",\n        \"taskType\",\n        \"inputs\"\n      ],\n      \"type\": \"object\",\n      \"properties\": {\n        \"inputs\": {\n          \"minItems\": 1,\n          \"uniqueItems\": true,\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/InputPort\"\n          }\n        },\n        \"name\": {\n          \"minLength\": 1,\n          \"type\": \"string\"\n        },\n        \"outputs\": {\n          \"uniqueItems\": true,\n          \"items\": {\n            \"$ref\": \"#/definitions/OutPort\"\n          },\n          \"type\": \"array\"\n        },\n        \"timeout\": {\n          \"minimum\": 0,\n          \"type\": \"integer\",\n          \"description\": \"User-defined timeout value (in seconds).\",\n          \"maximum\": 36000\n        },\n        \"taskType\": {\n          \"minLength\": 1,\n          \"type\": \"string\"\n        },\n        \"impersonation_allowed\": {\n          \"type\": \"boolean\",\n          \"description\": \"Allow the task to use user security token.\"\n        }\n      }\n    },\n    \"InputPort\": {\n      \"type\": \"object\",\n      \"allOf\": [\n        {\n          \"$ref\": \"#/definitions/Port\"\n        },\n        {\n          \"oneOf\": [\n            {\n              \"required\": [\n                \"value\"\n              ],\n              \"properties\": {\n                \"value\": {\n                  \"minLength\": 1,\n                  \"type\": \"string\"\n                }\n              }\n            },\n            {\n              \"required\": [\n                \"source\"\n              ],\n              \"properties\": {\n                \"source\": {\n                  \"minLength\": 1,\n                  \"type\": \"string\"\n                }\n              }\n            }\n          ]\n        }\n      ]\n    },\n    \"Port\": {\n      \"required\": [\n        \"name\"\n      ],\n      \"type\": \"object\",\n      \"properties\": {\n        \"type\": {\n          \"type\": \"string\"\n        },\n        \"name\": {\n          \"minLength\": 1,\n          \"type\": \"string\"\n        }\n      }\n    }\n  },\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"required\": [\n    \"name\",\n    \"tasks\"\n  ],\n  \"type\": \"object\",\n  \"properties\": {\n    \"tasks\": {\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"type\": \"array\",\n      \"additionalProperties\": false,\n      \"items\": {\n        \"$ref\": \"#/definitions/Task\"\n      }\n    },\n    \"name\": {\n      \"minLength\": 1,\n      \"type\": \"string\"\n    }\n  }\n}","name":"","status":200}]},"settings":"5601fdaa1ba3720d00a6b981","examples":{"codes":[]},"method":"get","auth":"required","params":[],"url":"/workflows/v1/schemas/WorkflowDescriptor"},"isReference":false,"order":18,"body":"The workflow system uses JSON schemas to validate user inputs.  Submitted task definitions and submitted workflows must comply with the schemas.  \n\nPlease see the [Task and Workflow Course](doc:task-and-workflow-course) for a complete explanation of the workflow definition.","excerpt":"Get the Workflow schema from the Workflow Endpoint.","slug":"get-the-workflow-schema","type":"endpoint","title":"Workflow Definition Schema"}

getWorkflow Definition Schema

Get the Workflow schema from the Workflow Endpoint.

Definition

{{ api_url }}{{ page_api_url }}

Result Format


Documentation

The workflow system uses JSON schemas to validate user inputs. Submitted task definitions and submitted workflows must comply with the schemas. Please see the [Task and Workflow Course](doc:task-and-workflow-course) for a complete explanation of the workflow definition.

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 }}