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": [
"dc2dec406482a196cc43e265",
"88982d41ead1f2574de4c472",
"54ba24a3dd9e44375874ae58"
],
"nodeLocation": {
"x": 42905812.99687508,
"y": 13208818.583462149
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"14ee3b1846c84c89be1d2f6b",
"1703d0568a57109d65d010f5",
"ebcbdf61851183e9c991e2c7",
"afd40f3bd41277250f3f2350",
"eb5bcd58777577aa9147eb49"
],
"x": 21046547.88415444,
"y": -29076805.841970146
},
"error_handler": {
"name": "childJob",
"summary": "minim esse",
"description": "magna id sit sint aliqua",
"app": "amet laboris mollit",
"variables": {
"error": ""
},
"groups": [
"cf200ba256c09533fdd5e00b",
"07e3af7bd259a14c2b6ccac0"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"053a074422cc940b21f5468f",
"26ddfdb4a4703acf7c05ae89",
"e218a27e52164d4a834dd623",
"ee18e763f5f92375ef31b348",
"db60e75a917bdc49780768f4"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "dolor officia deserunt",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1947-07-22T06:39:47.758Z",
"created_by": "36d0e35d6307520db99f0b06",
"last_updated": "2023-11-14T01:17:40.171Z",
"last_updated_by": "c52d6f8be29d2e85eb5836d0",
"lastUpdatedVersion": "dolore laboris",
"tags": [
"Lorem sed irure",
"cillum consectetur nulla",
"magna",
"reprehenderit dolor ipsum velit",
"est Ut tempor in"
],
"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"
}
}
}
}