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": [
"a2f29701d0d01d926d28606a",
"4d7ef732077ad817ad380c42"
],
"gridCoordinate": {
"x": 45918322.59364885,
"y": 8872574.56366095
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"67364ffc37bf69388c793f58",
"f67ecba41fbd79a2b77abab0",
"2cf522fe1c014fb2bdcdba3d",
"d983bfba0e9ce2de3ef77640"
],
"gridCoordinate": {
"x": 44663377.61734116,
"y": 31768695.582100064
}
},
"error_handler": {
"name": "childJob",
"summary": "dolore sunt",
"description": "veniam deserunt sed et",
"app": "Ut labore adipisicing quis anim",
"variables": {
"error": ""
},
"groups": [
"82dcfa8f2c74148f273d7b30",
"0558e9a7efcd0ca81c33d485",
"e5efeedf56a155ca573ef133"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"6422031ba60a568f90222c17",
"f10a0a30b7b1e7b7197bafba",
"5816e8380a9b8bd39c0f6231",
"fd5d3c397c32af7a1ad5bba4"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "exercitation labore esse elit consequat",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2018-12-29T09:22:35.371Z",
"created_by": "0b70fdc25fecb4e8acff510a",
"last_updated": "1990-12-21T11:49:57.381Z",
"last_updated_by": "8287adbfb68d10eb5faa2bf9",
"lastUpdatedVersion": "ea",
"tags": [
"reprehenderit Excepteur",
"officia exercitation velit pariatur",
"est ipsum ad Excepteur sed",
"sunt non occaecat ullamco esse",
"id"
],
"canvasVersion": 1,
"encodingVersion": 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",
"items": {
"type": "object"
}
},
"warnings": {
"type": "array",
"items": {
"type": "object"
}
}
}
}