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": [
"87da7d96affad7453cdbb2a8",
"07e0c83705e307b38cadcd52",
"004f89c8cbb761cc07b08bc8"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"737af214b2936418b323b6e0",
"940828f1f27ea589af6e852b",
"bca356b183684f432fcccc97",
"f83aad6c761798379f22f5ba",
"c3bb06cdd7b604c7c01713d6"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "velit Lorem exercitation ullamco irure",
"description": "in ex",
"app": "dolor veniam pariatur",
"variables": {
"error": ""
},
"groups": [
"bf999ecfe8700c25fcbcfd53",
"5eb9a1d88093121c2a6b704d",
"68ec7d44ee3487fc32a6074f"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"error",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"0d4eeb76de97dd26d4cdb5c6",
"dcde2d982db7e9607a5285b7",
"20d43befc617642677e7b4cd"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "est",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1950-03-16T15:24:16.779Z",
"created_by": "5b282f39ca4a59d798e9b39a",
"last_updated": "1973-10-26T17:59:51.77Z",
"last_updated_by": "c4efe2068d1fc708a4c70f10",
"lastUpdatedVersion": "nulla ipsum dolore proident ullamco",
"tags": [
"occaecat"
],
"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"
}
}
}
}