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": "minim pariatur",
"description": "ipsum",
"app": "deserunt commodo dolore anim aliqua",
"variables": {
"error": ""
},
"groups": [
"9fef4fd767132593f3391c33",
"e2c0d97c6e6113883719e9f4",
"5cef88a9ff38c22c44a7e772"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
"6a104ab15c9be209c8eaa38f"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "nisi est",
"font_size": 12,
"created": "1990-12-23T08:23:18.971Z",
"created_by": "2965f72180123a10487f19d8",
"last_updated": "1954-01-29T11:51:47.526Z",
"last_updated_by": "cca4db7411e904b6147f4592",
"lastUpdatedVersion": "nulla et Excepteur qui occaecat",
"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
{
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}
