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": [
"ce43105991959aa30abb6eab",
"111923d61fd7d08857d6e398",
"5ef0b97594f2602309eb823a",
"0a99b982401cc3ea888c98e9",
"afb598d505710807ac73c1da"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"1c1ffbdefdd26e87bd6b3359",
"af50872391529260475895b5",
"a01df2e6d3159e1ef3001dc0",
"188e92b88c27c857f243b16b",
"216cae8e71b715c6cfddb705"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "mollit voluptate veniam",
"description": "laborum aliqua deserunt exercitation",
"app": "Lorem aliquip",
"variables": {
"error": ""
},
"groups": [
"165d9d132fc589c4131bc69c",
"ec279ab091bf011dae3d34ec"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"561d3f516c15cdedff3fa53e",
"5c59c44a9f4eecd620714d12"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1973-07-03T20:07:48.711Z",
"created_by": "30b0934f9ce01380110402ef",
"last_updated": "1964-07-20T20:24:00.056Z",
"last_updated_by": "3f8c08879562054d29667122",
"lastUpdatedVersion": "tempor aute est",
"tags": [
"in Lorem adipisicing elit magna",
"esse Duis"
],
"canvasVersion": 1,
"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"
}
}
}
}