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": "nulla ea Lorem",
"description": "sunt ex laboris dolor",
"app": "exercitation fugiat tempor",
"variables": {
"error": ""
},
"groups": [
"c86941f27b464c25a6d9f2cc",
"5c5ebe37efe82c57ddec4b95",
"a44de49659104a8a8927b8cc"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"d11b7727e1a4eddb5d012844"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "laboris commodo",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1959-06-30T18:44:35.197Z",
"created_by": "649288b753748729901d9691",
"last_updated": "2006-11-21T02:42:37.528Z",
"last_updated_by": "1a7b5d30b78d6f97bf511f44",
"lastUpdatedVersion": "ut non",
"tags": [],
"canvasVersion": 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
{
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}