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": [
"3c68bbafab6e67035141dd3b",
"97ca9fae6bb71d1a309f4dc3",
"86f3a822897197a0e08b062e",
"f57ef29894057d49dee2891c",
"bfe27f773d49a1f3f9217945"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"a250c39b4fb4f70f2f1b5611",
"755b6e94194ccecac9a8735b",
"10dc7944380949ea269a9074",
"4203fff606aed55dab9aa0ad"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "aute mollit dolor",
"description": "in in ipsum culpa officia",
"app": "enim ut exercitation",
"variables": {
"error": ""
},
"groups": [
"d0845cebe2da94de44a809df",
"59f7f1de7a2b39443fc45a96"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"success",
"failure",
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"af331d5af697f380d7b6f959"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1950-04-02T23:39:26.673Z",
"created_by": "4d8c47071cd1a422225c5f33",
"last_updated": "1956-07-18T05:40:43.239Z",
"last_updated_by": "80290595811e0cf5ba1759ef",
"lastUpdatedVersion": "minim fugiat laboris",
"tags": [
"dolor id incididunt sed",
"nulla elit ad",
"cillum dolor velit exercitation aliquip",
"sunt"
],
"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"
}
}
}
}