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": [
"cd247719bb0d7f3a85465431",
"04857cb7d9af1c502ca7cc50",
"cc965a528aff1c29150166c3",
"cd21d4891e90e4aa452d38a7",
"dbce3ece0e83ba89fae4deba"
],
"nodeLocation": {
"x": -61001949.69200965,
"y": 86462797.63374066
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"404aae4160451435313b1478",
"662daebb19930d1e01ac15fa",
"d17fb2b8470bb07f9bf308a3"
],
"gridCoordinate": {
"x": -71247752.52861415,
"y": 73495176.66980067
}
},
"error_handler": {
"name": "childJob",
"summary": "sed",
"description": "laboris",
"app": "et in consectetur incididunt laborum",
"variables": {
"error": ""
},
"groups": [
"2b2a621fd2f2d49260f75203",
"ab60b89c6a15efc3ea8e5af6",
"451718d6e428e82e20bb974c",
"9bded2e0d1ea63c78af5b398",
"b9fb38449a76d710d519d200"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"28a472e983ea8d3f482658c6"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "laborum non",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2016-10-07T13:00:01.997Z",
"created_by": "d7d1fbd8f8f4458e3a5146a0",
"last_updated": "1989-06-29T14:55:14.422Z",
"last_updated_by": "46e71cee98ef8eb2d314f949",
"lastUpdatedVersion": "exercitation ea deserunt",
"tags": [
"fugiat aliqua est veniam occaecat",
"laboris ut commodo amet sint",
"sit adipisicing laborum incididunt",
"deserunt irure id ex occaecat",
"laborum voluptate dolor occaecat officia"
],
"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"
}
}
}
}