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": [
"7036b31262c14d8bc532e311",
"62e46b239860b749f3c4a914",
"69358bb171e2e86f09393f17",
"7841127773e807b2e1cb3e67",
"db34ab33f51742aeb7f37dfa"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"91d8833a5e5041dd62081881",
"f858dfec6ac56c64a8055fab"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "sunt",
"description": "aliquip Duis adipisicing ea pariatur",
"app": "quis eu ea esse",
"variables": {
"error": ""
},
"groups": [
"0aacebaa79310ef673f94081"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"success",
"success",
"success",
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"8e667981626998a0bd42cd73",
"cb92ffadcf70d31d1d2f37c0",
"d0b80683a7071e9f997c9677",
"21f35d4b03dd4a69224ca57a"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1959-04-08T05:58:20.427Z",
"created_by": "701ba3b68e746616821cda17",
"last_updated": "2023-09-24T21:21:53.61Z",
"last_updated_by": "ba3eb74995c6bdd5a250f683",
"lastUpdatedVersion": "sint occaecat",
"tags": [
"ad",
"non",
"laborum reprehenderit officia Ut cillum",
"in anim exercitation"
],
"canvasVersion": 1,
"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"
}
}
}
}