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": "ut",
"description": "in anim sunt fugiat amet",
"app": "dolor aute minim proident adipisicing",
"variables": {
"error": ""
},
"groups": [
"a30e77183f681eae70fee969",
"4b8e3abd3dac0f4422590daf",
"cc93f14bda76dad1e8ef1f36",
"5b3d1f62bd46a887125ca965",
"7fba7909c6b4e197ead04c27"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"failure",
"success"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"e49c6f7e5479ce734e9efc51"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "2001-01-13T02:51:03.14Z",
"created_by": "c7eeceaaf6d7d34626bdb26d",
"last_updated": "1978-02-16T10:23:22.05Z",
"last_updated_by": "0e6d442970a1e1cda142e9cc",
"lastUpdatedVersion": "sed sunt reprehenderit",
"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"
}
}
}