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": [
"687e32d6bff3a505a744fd9d",
"793da2635031afecdf395522"
],
"gridCoordinate": {
"x": -65036651.760139994,
"y": -97044251.09419645
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"e61851d88ef03aeb3afd4403"
],
"gridCoordinate": {
"x": -83394172.38382012,
"y": 22118755.802708328
}
},
"error_handler": {
"name": "childJob",
"summary": "magna esse id ex commodo",
"description": "dolore ullamco",
"app": "incididunt",
"variables": {
"error": ""
},
"groups": [
"695f9fd4b361f6fdf5900a4e",
"deb484c0979126fb4de3ef12",
"3e09a438277dd182ae9a2c91",
"ac225d7b8a440bcebe7bf659"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"474bc4f74492b4bd432eed55",
"d87b88d88a41b108d7bb6001",
"4fec699cf99d7f9da43ed23c"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "amet ea",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1958-06-04T15:47:33.39Z",
"created_by": "87bdecb63b4095921b8ea3f1",
"last_updated": "2015-04-22T10:13:32.39Z",
"last_updated_by": "0d7b095384b299bb1549d070",
"lastUpdatedVersion": "deserunt qui",
"tags": [
"deserunt ullamco labore"
],
"canvasVersion": 2,
"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"
}
}
}
}