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": "ea",
"description": "eu sunt ea aliquip",
"app": "enim dolor",
"variables": {
"error": ""
},
"groups": [
"57e2b52ab106a016658c0345"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"error",
"success",
"error",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"1bec71479cef4d5c296232f7",
"f0c52e0befe374f6b5cb96b9"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "Ut enim in sed",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1974-07-19T06:34:08.603Z",
"created_by": "bdea31d4fbf3bb59971e2729",
"last_updated": "2002-12-21T17:50:19.167Z",
"last_updated_by": "b98132f4f1cbd381409bd55f",
"lastUpdatedVersion": "dolore",
"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"
}
}
}