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": [
"50082a4dbff0c45153b54555",
"b5a975a9036d207d06b8bc42",
"1e57e0cab00faeeb3fcdd68f",
"a5038a18ad8953b7afe888c3"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"24d6733e20eea4556e8210ed",
"64516249b2a8e6f7a9619f56",
"422a870b5cc385a9535b97eb"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "veniam irure enim proident",
"description": "laboris labore ut dolor sed",
"app": "veniam cupidatat do",
"variables": {
"error": ""
},
"groups": [
"f8815f69001b2e227464e975",
"e5051f21cd0ed77018e4fef4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success",
"success",
"error",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"c3be3a05604f5c38c45f425c",
"1d587c08d041e2f197eb7e83",
"6e54f066aa2a6f211e2f3c33"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "sed anim eiusmod ea exercitation",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1949-01-18T16:01:20.816Z",
"created_by": "29f027d2f5b15ba58092abab",
"last_updated": "2015-07-17T18:30:47.791Z",
"last_updated_by": "ea66ab5b82bbeb221b36a288",
"lastUpdatedVersion": "anim ex deserunt consectetur reprehenderit",
"tags": [
"ad Lorem reprehenderit nulla"
],
"canvasVersion": 2,
"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"
}
}
}
}