Summary
Validate a workflow
Description
Validate a workflow, and return the resulting errors and warnings arrays.
Route
POST /automation-studio/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": "consequat ipsum exercitation",
"description": "minim",
"app": "non",
"variables": {
"error": ""
},
"groups": [
"4ad11b3036bd735b32dcb514",
"552b27e7c5e57661418557dc",
"f113db77907c580807667ee4",
"3d0ccca5f07208b5ae5b304e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure",
"success",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"648f4532009adcb9e9948db2",
"61357d2017bfa71a2d8ac931",
"f07f60a103f44a2379f8332c",
"6de35ee7079bdd2125d8fad1",
"e5a019b8ce5748eab680b954"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1957-03-20T10:15:37.964Z",
"created_by": "036b61c096a105bfd89c22ae",
"last_updated": "2005-04-12T20:25:36.236Z",
"last_updated_by": "0099dfe9c8920172a10ba73e",
"lastUpdatedVersion": "cillum",
"tags": [],
"canvasVersion": 2
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"title": "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",
"title": "validationResult",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}