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": [
"885924da50ca1fed306bbf98",
"6c2849a6c43dc81a74d3c4cd",
"688aaa476651e688587943b4",
"42815f71807653fcdd488f56"
],
"nodeLocation": {
"x": -19795651.989624828,
"y": 38914164.593185276
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"8d607231a90134e553a83296",
"38afe3a7fae31d0b038734e2",
"efaa7be4097833eeda5c8c58",
"a71daf60a029c7211fd81762"
],
"gridCoordinate": {
"x": -54836455.07027699,
"y": 97298994.22289065
}
},
"error_handler": {
"name": "childJob",
"summary": "minim",
"description": "in",
"app": "mollit sunt sit anim",
"variables": {
"error": ""
},
"groups": [
"5272d52cc6d2115557c4a314"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"69c17ff392b952fe49663b6f",
"d7d2fa99d9800944ce9afa83",
"878ba7a16421b71345533bf5"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "irure",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1962-05-12T22:46:28.244Z",
"created_by": "1597fa4a5b8655c7743705bb",
"last_updated": "2013-12-03T19:16:14.969Z",
"last_updated_by": "93a7c65c2f1e9310d38c044c",
"lastUpdatedVersion": "consectetur ex labore mollit",
"tags": [
"minim enim",
"fugiat dolore laboris sed",
"tempor voluptate id",
"anim ea Excepteur"
],
"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"
}
}
}
}