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": [
"af5f67f95616eff2d04c5ffe"
],
"nodeLocation": {
"x": 86665039.07605606,
"y": 79170063.12555164
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"59436b7f8d55bbf8e06f7f69",
"12b7a3472aeeda5c4cdb92c5"
],
"nodeLocation": {
"x": 78473241.61845392,
"y": -47973350.95433954
}
},
"error_handler": {
"name": "childJob",
"summary": "ea incididunt labore ipsum ut",
"description": "ea dolor velit irure enim",
"app": "et enim",
"variables": {
"error": ""
},
"groups": [
"1c02165310618e28d8c6c239",
"9c681565edda568070b334eb",
"11b49c067480c04f2fd24625"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"8255d629e44d928d8a0af334",
"2771a310eaa35f1b9ab8f7ac"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1965-04-09T09:59:00.857Z",
"created_by": "76092706fbd90294377d5440",
"last_updated": "1969-03-10T02:24:01.344Z",
"last_updated_by": "dcd71840bdbba11528144c6f",
"lastUpdatedVersion": "fugiat sit id",
"tags": [
"sed ullamco",
"dolor"
],
"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"
}
}
}
}