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": [
"9991ceb744883dd610d37ac6",
"f1936ceafdde3d18ef7600de",
"31bdb8ca07e04307b2d10740"
],
"x": 44078683.36515254,
"y": 7197171.03007853
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"fd8ed574c97faa0d84374dd7",
"7ae94e19b94d9936d94a8f19",
"a0c45bb1e286c2e13fbdeecf"
],
"x": 165503.38086025417,
"y": 40973634.81577602
},
"error_handler": {
"name": "childJob",
"summary": "nostrud",
"description": "irure deserunt nostrud consectetur",
"app": "proident minim nulla ex",
"variables": {
"error": ""
},
"groups": [
"bd5aef686c0a54732fb80f00",
"520ac49c8c0fa39635553a5d",
"2fc0f243e83c048717a09953",
"38b7ee0986c546bd0e182ff7",
"4c714ff94da7fc66e00cc6fe"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"failure",
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"3e0b3795def203371eb0abc9",
"70ba8c6084aa7b3f96e9ab03",
"70a28dee8a8307959b5938d2"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "anim laborum reprehenderit irure cillum",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1983-03-17T12:13:09.105Z",
"created_by": "9205409a2b7bce0f3f315a60",
"last_updated": "1973-09-11T23:07:25.579Z",
"last_updated_by": "2c1a8891c920fdc6c551630d",
"lastUpdatedVersion": "sunt eiusmod Duis",
"tags": [
"culpa est et 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"
}
}
}
}