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": "incididunt ullamco laborum anim sed",
"description": "eu in dolore",
"app": "ipsum consectetur et",
"variables": {
"error": ""
},
"groups": [
"57c51602f683ef85681cb972",
"22577559334bf35185ee6bca",
"4bae5bb511c7325401d2190e",
"9de546aec5c17302bea8412a",
"572f6499740a51819c1c70f2"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true
}
},
"transitions": {},
"groups": [
"5e8bdc31e0d91aa09e014f03",
"ac70eef8f8805292e9f66fa8",
"4ea7505de62fa2cf23cb21b4",
"5cba4df1350202d4f8032581"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "elit",
"font_size": 12,
"created": "1999-02-14T20:22:32.116Z",
"created_by": "6399705a4444577bc9201cb2",
"last_updated": "2020-07-09T12:35:37.615Z",
"last_updated_by": "f96823411991612a412d6c15",
"lastUpdatedVersion": "ad elit labore",
"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"
}
}
}