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": "fugiat consectetur enim",
"description": "aliquip pariatur esse",
"app": "dolor dolor sed sit",
"variables": {
"error": ""
},
"groups": [
"e99fec709ce49e0cfdca2af5",
"1f9014111952f0bc7a445d26",
"de0b94a56b10403194cc21d9",
"208fdf0b1ad89e360f6bcf97"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"4f2b71ee2b572824e1fa28fa"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "incididunt culpa esse Excepteur irure",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1959-08-12T23:03:01.669Z",
"created_by": "9843be28ac49f9d28cf1b962",
"last_updated": "2012-01-17T03:54:34.42Z",
"last_updated_by": "3b85f1b14d9e866809396beb",
"lastUpdatedVersion": "occaecat cupidatat",
"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
{
"title": "validationResult",
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}