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": [
"3bc40dc59537639e8a5c5ef9",
"3a1aa5e7b5e52772ff49fbc3",
"ecf4f4a5b80dfe7a51e69d82",
"e2c7824ee92db7df6dc76cd7"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"d1842b0484680fe6f9d554a6",
"738c32349fadec9fd251ecdb",
"5568189f745633c54d0c4fe3"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "proident velit consectetur tempor",
"description": "nostrud",
"app": "elit cupidatat dolore",
"variables": {
"error": ""
},
"groups": [
"c5a02d05efea8a3905083388",
"a90e897337ed1bce478301aa",
"5650cd7ad25ca6a007afe32e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"failure",
"error",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"0edb02287042257f1d637682",
"effefcd6568cbd61ef5c955e",
"1dc6afe26825fdda651db86b"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1974-11-17T04:58:54.625Z",
"created_by": "a4fc8b5bed782ea9d0827186",
"last_updated": "1999-05-06T13:58:43.232Z",
"last_updated_by": "b26ac82a66b61aa2bffcc4ba",
"lastUpdatedVersion": "aliquip",
"tags": [
"amet magna",
"minim est"
],
"canvasVersion": 1,
"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"
}
}
}
}