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": [
"426622a5bb066b8a64ee0497",
"786b80ae34084f07fe939e3e",
"5d35771b31d418431afdcf18",
"fc05342bf3bfa635c05a4932"
],
"x": -60479613.673016265,
"y": 69651145.69439569
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"6372dc59d99ad430b2a1454f",
"1f20170c2e030c24d11be4d8",
"6dc8876cd823342e31ffed90"
],
"nodeLocation": {
"x": -67817591.10479459,
"y": -81717323.91346213
}
},
"error_handler": {
"name": "childJob",
"summary": "nisi",
"description": "nostrud",
"app": "Excepteur ea velit et",
"variables": {
"error": ""
},
"groups": [
"a4d7fd45cfe2576a33630934"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"success"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"1ff7a40305073fde99b4e680",
"43172a8821d5435fbb47c288",
"24281a59dfc59faea751e00c",
"18ceb2a92195d3d8c490db3a",
"9fe8b7c0932cb61b627cc72f"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "veniam in",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2008-05-17T12:24:53.416Z",
"created_by": "99fd0b425c3968c4452bc5b0",
"last_updated": "1988-10-01T02:33:05.009Z",
"last_updated_by": "cb3cacac5cf279367d9e298f",
"lastUpdatedVersion": "magna in cillum",
"tags": [
"anim in irure",
"ut cillum minim",
"adipisicing cupidatat consequat sunt reprehenderit",
"labore Excepteur sunt",
"amet"
],
"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"
}
}
}
}