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": "ipsum laboris enim",
"description": "Duis cillum nisi",
"app": "ea",
"variables": {
"error": ""
},
"groups": [
"51d2f0c66c8c9a51877ccf5b",
"acfe999dbc82760f3111d2e3",
"048f69356affc04d4699e3c8"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"32c594d51d4a1b3eae3f37a5",
"959ccfe6e2ab73c8d4d3f8b0",
"4158c855a61544d8c7529ac2"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "anim dolor",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1985-02-14T13:49:59.321Z",
"created_by": "aa4b3741734675c209f4be50",
"last_updated": "1962-07-20T16:30:43.752Z",
"last_updated_by": "78f24bd0eaefc8c29589c2af",
"lastUpdatedVersion": "id irure ut amet incididunt",
"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"
}
}
}