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": "nostrud culpa voluptate",
"description": "id",
"app": "veniam commodo esse exercitation",
"variables": {
"error": ""
},
"groups": [
"8b450ec4598a485ab899f6ef",
"4385dd89242f99b7b1641d35",
"77adcdf00b7cba62745886fc",
"785667e4878b8bf4e5d3c44b"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"93be503031590144d3058d87",
"0fc86e24ecf8cea4e06b12bd",
"38e5ffe614389bd89880362d",
"96dd3c6ba004cf8542706c8b"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "2015-10-07T14:32:01.257Z",
"created_by": "052c995259eaf1c6332912be",
"last_updated": "2018-04-28T08:31:27.943Z",
"last_updated_by": "e9a3b903f0b0007f62eaa1f6",
"lastUpdatedVersion": "laboris anim",
"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
{
"title": "validationResult",
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}