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": "dolor minim exercitation aliqua proident",
"description": "in dolor",
"app": "in esse officia nostrud fugiat",
"variables": {
"error": ""
},
"groups": [
"e33ce1ea1565ed8ceb351093",
"fd2dbfc577d53c72753e22c5",
"85581b5d5a2f9cc991e581e7",
"3a0962e2b7446fcc9134162b",
"1c054c2883ad03ec49e20a9e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a061fc3e4b04b882677700ce",
"b0e0445ca8db4248a1f01f2f",
"2cd5d96d7ca03297fa64fd93",
"6e23f1bdaac1440b3157bc58",
"d9a1022a3c90c88a21895720"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1969-06-23T17:59:19.1Z",
"created_by": "aee584e9ffd597efc66e66cf",
"last_updated": "1984-04-05T07:24:19.225Z",
"last_updated_by": "f7d407698469f5b92da2b657",
"lastUpdatedVersion": "Ut",
"tags": [],
"canvasVersion": 1
}
}
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"
}
}
}