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 laboris",
"description": "tempor in Duis aliquip",
"app": "laborum in do",
"variables": {
"error": ""
},
"groups": [
"ba8bd6b01fae0a124aa545e4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
"6993e4d8d535125a72d96dfb",
"2d0ca47ffde584f598e1e758",
"28fcbed1280125dffa5e1dd4",
"ab7ccfc1d1bb4a7afbf057a3",
"e269b44d8b147efc409da36a"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1964-07-15T13:44:35.445Z",
"created_by": "5c04a7559c41866687bbe59a",
"last_updated": "1965-02-24T01:57:36.48Z",
"last_updated_by": "8d4026087d4df80473e4c57a",
"lastUpdatedVersion": "id",
"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
{
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}
