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": "commodo",
"description": "elit culpa nulla irure",
"app": "velit",
"variables": {
"error": ""
},
"groups": [
"719f3491250c634ec2bdb341",
"f646ddf4f478887065f2177b",
"d09fd929541ccef9a4eaca69"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
"645448de788b7c8123ad54a7",
"b4fde41d5cb93a854c1d4af2",
"57b374c05dab5c113a7c60d2",
"5928430686fcf1bd51579569",
"65811213b5b2afe78738bd81"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"font_size": 12,
"created": "2016-05-22T21:25:04.341Z",
"created_by": "4cc044266c1cea3fd29d903b",
"last_updated": "2001-01-30T00:09:17.301Z",
"last_updated_by": "3dace120cb6b317096853275",
"lastUpdatedVersion": "dolore do",
"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"
}
}
}
