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": "deserunt",
"description": "est consequat",
"app": "amet ut",
"variables": {
"error": ""
},
"groups": [
"7f3e4b76b740bad3389a8d79",
"a655c144bea92cde53d7428d"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"error",
"success",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"eede98fc77dece5c890c22c0",
"4100033ea5aee2ded8d05c5d",
"d7b8edc8dac5c14dc1073afc"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1955-01-18T18:37:22.237Z",
"created_by": "99da6eaf37beedff97cb81a6",
"last_updated": "1970-06-29T06:07:20.945Z",
"last_updated_by": "198fcbab30440f1bb7fd4d26",
"lastUpdatedVersion": "dolore amet adipisicing incididunt enim",
"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
{
"title": "validationResult",
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}