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": [
"d57f3118740f168b8fb74e0a",
"0bfc306a403f456343ec5a31",
"9bdb0cded0cfe8564eaa66f1",
"d43290e3ec792569b7aaa80f"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"69f688f7c47b49c0499bb9fb",
"dd8d110aff551b9945f065b4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "anim et Ut cupidatat",
"description": "ipsum dolore",
"app": "ullamco amet cillum consequat",
"variables": {
"error": ""
},
"groups": [
"1c182be9f05d6094094698bc",
"32e0c90cca75d52adb891e12",
"4e5568ce3069e40c4318e568"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"06320c3cab662a84ba0d4b8c",
"a8fe744f2d04a6240784cc36",
"245e19741a4be6cc9bec9787",
"c609ed6b07d2eb2100e38fdc"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "quis cupidatat ut dolore",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1965-10-21T22:31:55.914Z",
"created_by": "42320fd6a66ac21b33fc21a5",
"last_updated": "1983-05-11T02:16:26.559Z",
"last_updated_by": "32f96745e0278aa5d0a60749",
"lastUpdatedVersion": "nostrud aute id",
"tags": [
"Excepteur sunt cillum eiusmod"
],
"canvasVersion": 2,
"encodingVersion": 1
}
}
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",
"items": {
"type": "object"
}
},
"warnings": {
"type": "array",
"items": {
"type": "object"
}
}
}
}