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": [
"511def1bbe7432e4b28411e1",
"fcbe1b9e1c906cc91e44a531",
"0339b33fd5972500ae36cd36",
"e5c7844f1d24a113d304ea4d"
],
"gridCoordinate": {
"x": 63762682.32073775,
"y": 44582823.57283908
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"8a8bc58a927dfdf905e98ea2",
"a21ec77546cff8d501199920",
"7963d4c07cbecf0dcf20db29",
"9090fbf8a2d5a324f1c37ad5"
],
"nodeLocation": {
"x": -57450412.29062031,
"y": 88310475.78218359
}
},
"error_handler": {
"name": "childJob",
"summary": "aliqua commodo eu",
"description": "elit sunt consectetur",
"app": "occaecat cillum",
"variables": {
"error": ""
},
"groups": [
"0dad30d204be26072eba0eea",
"a575dade2927a08d9822053f"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"error",
"success",
"failure",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"9a715ec2cc8f06f90a3a0fb6"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1966-12-13T20:50:42.287Z",
"created_by": "6aa5ded51bca7101a9197d90",
"last_updated": "1981-08-22T01:35:01.831Z",
"last_updated_by": "2c826ccb4358e5ea0ebe81ca",
"lastUpdatedVersion": "aute sunt irure occaecat sed",
"tags": [
"qui aute ipsum proident commodo",
"magna Ut nulla"
],
"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"
}
}
}
}