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": [
"37bbb1b1ebbeeaee59203904",
"7bef0ddf5c9d4611d06a7800"
],
"nodeLocation": {
"x": -86861649.08084705,
"y": -33652722.113988265
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"64b74ca139231fc6c5d00006",
"4f9b7aa3e4c552e27a39e925"
],
"gridCoordinate": {
"x": 83154892.8882258,
"y": 63066357.54336774
}
},
"error_handler": {
"name": "childJob",
"summary": "magna exercitation dolore pariatur in",
"description": "non",
"app": "laborum labore",
"variables": {
"error": ""
},
"groups": [
"f7c8e15dff6dfba1fc7ad83c",
"28a0b066080813d4708503f4",
"a390fa4e402f059baa45c003"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"8c8ce48ffc2315e533486fb0",
"e8e9adb05adf2dfa87fef389",
"1cfd1e835d66d435e4555e22",
"8c2f37417892f7ae615cc996",
"1495b7c14669d12509600acb"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1999-08-17T14:10:36.804Z",
"created_by": "04295dc07019c7c3b75fbc88",
"last_updated": "1963-12-18T11:19:38.118Z",
"last_updated_by": "62b1a4ab4e816cfa0add330b",
"lastUpdatedVersion": "aliquip dolor do incididunt",
"tags": [
"esse reprehenderit"
],
"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"
}
}
}
}