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": [
"858b34fd71c2d9495e61a659"
],
"nodeLocation": {
"x": -30359707.84146644,
"y": -20621099.4661503
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"488f3519f0dd6ceba92cc406"
],
"x": 71784804.99754047,
"y": 53386201.529654264
},
"error_handler": {
"name": "childJob",
"summary": "mollit",
"description": "cupidatat",
"app": "culpa dolore voluptate ut sit",
"variables": {
"error": ""
},
"groups": [
"d1171cb2060e447c9d25b220",
"74ea52fc5840f460abf5bc3f",
"1e37cf3726718873dcee741f",
"ad71ebb9c801d1da2330e2fe",
"d3d4c5803034208a62f1e265"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"9d8a4e9ed5d886cd847a89ed"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "2021-07-02T07:05:18.983Z",
"created_by": "c40e8b7c9c9cad1fdedae698",
"last_updated": "2017-09-13T08:27:06.423Z",
"last_updated_by": "d3cd0caae3b997aa139f9f0f",
"lastUpdatedVersion": "nisi et",
"tags": [
"ipsum velit minim sed",
"veniam pariatur dolor Lorem ea",
"nostrud ex",
"ad occaecat 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"
}
}
}
}