Summary
Validate a workflow
Description
Validate a workflow, and return the resulting errors and warnings arrays.
Route
POST /workflow_engine/workflows/validate
Roles
admin
engineering
support
apiread
apiwrite
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| workflow |
object |
yes |
The workflow to validate |
Copied to Clipboard
{
"workflow": {
"name": "My Workflow",
"type": "automation",
"tasks": {
"workflow_start": {
"name": "workflow_start",
"summary": "workflow_start",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "sunt nulla voluptate aute adipisicing",
"description": "commodo",
"app": "laborum proident",
"variables": {
"error": ""
},
"groups": [
"517a696388f4821dd494c713",
"b447272b7fdfa7769deafc4c",
"4cb1f951c9ed2687aafbeffa",
"48840e71625962e407e1f341"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
"7721a509cb30fffd2be01675",
"f9d84664ea9ab9929d8bc957"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "ea et laboris commodo",
"font_size": 12,
"created": "2012-01-01T21:53:46.615Z",
"created_by": "d57399bfe1bb87a006cc0e0d",
"last_updated": "2005-05-27T10:59:18.653Z",
"last_updated_by": "07265e3860f434e8d6c1db82",
"lastUpdatedVersion": "consectetur",
"tags": [],
"canvasVersion": 2
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"$ref": "workflowDocument"
}
},
"required": [
"workflow"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| validationResult |
object |
Errors and warnings output from the validation process |
Copied to Clipboard
{
"errors": [],
"warnings": []
}
Copied to Clipboard
{
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}
