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 aliqua cillum",
"description": "amet",
"app": "eiusmod ad aliqua pariatur nulla",
"variables": {
"error": ""
},
"groups": [
"f5de615828f5869582eeddd4",
"2bd39b6de63067ca29446238",
"aaea886e4cb3cbfca57fc616",
"e6bca4b3a72d55013aa5d974"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"failure",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"6bbb089ff3e4c131c95bb4f9",
"cef10b369160d956d531f26b",
"9bb719e73b927b46f87e1619"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "est",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1985-04-25T07:50:36.899Z",
"created_by": "e9b205c5ae6ef4dc741fdc58",
"last_updated": "1998-01-01T16:17:41.407Z",
"last_updated_by": "8dc7cac841d39b33b866cc63",
"lastUpdatedVersion": "occaecat ex",
"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"
}
}
}