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": "do",
"description": "cupidatat velit et eu",
"app": "voluptate ad ipsum sed officia",
"variables": {
"error": ""
},
"groups": [
"325ee603cdd16bb9189bdcc0",
"dbb9eefe33428c5042f23528"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
"eba5a67e95b81a43c6018995",
"96a745701af16aa9afd6ae4f",
"4c6c4fb964364cebb8783c3a",
"057ec8beeae18676140d3b42",
"af0a70033809e9dd17400046"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"font_size": 12,
"created": "2003-05-03T01:58:56.08Z",
"created_by": "d92392699e841b2f828f95f7",
"last_updated": "1987-08-27T05:00:21.255Z",
"last_updated_by": "358ce3857416391324a303db",
"lastUpdatedVersion": "Duis dolor",
"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"
}
}
}
