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": "consequat",
"description": "in Ut nisi laborum",
"app": "officia quis nisi irure ut",
"variables": {
"error": ""
},
"groups": [
"30f21648c4d36a2faebf2e64",
"e75c12437b21c6d6f6c56e21"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
"97e44afae041d3a09c9e161d"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"font_size": 12,
"created": "1956-09-25T01:07:32.507Z",
"created_by": "f13149b29a62cff4c5bf7c5e",
"last_updated": "1964-04-14T03:51:29.327Z",
"last_updated_by": "8a3b537a528de3fe700917b2",
"lastUpdatedVersion": "exercitation officia culpa amet",
"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"
}
}
}
