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": "amet officia",
"description": "anim",
"app": "irure nostrud dolor exercitation et",
"variables": {
"error": ""
},
"groups": [
"3e5aea88942cc405d9d2e1e0",
"de6953449960cd0a5a79ab6e",
"905b0087f6fc37522634b8cf",
"8662df4d5ac55b58502d8f5b",
"ad03ebd77e32de22ccc5b368"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
"d668da3eb6a6f410a7bfd9f9",
"63d9e412b06eb5909839722f",
"d8913704e0ac41bb3d161a42"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"font_size": 12,
"created": "2013-04-03T04:36:38.656Z",
"created_by": "efd14c9abd3ed723a843fd37",
"last_updated": "1944-04-16T10:45:55.563Z",
"last_updated_by": "beb9c429ceba730ac0e6467c",
"lastUpdatedVersion": "laboris sunt id reprehenderit magna",
"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"
}
}
}