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": [
{
"name": "et officia reprehenderit cillum",
"provenance": "reprehenderit"
},
{
"name": "sint irure",
"provenance": "tempor eu officia"
},
{
"name": "Ut",
"provenance": "sunt"
},
{
"name": "dolore esse laborum do minim",
"provenance": "minim Ut ipsum sed exercitation"
},
{
"name": "do",
"provenance": "minim ad aliqua"
}
],
"nodeLocation": {
"x": -77208144.29100353,
"y": 82390358.61906102
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "aliquip occaecat ut cillum labore",
"provenance": "laboris"
}
],
"gridCoordinate": {
"x": -61596904.01275726,
"y": 89534839.98663771
}
},
"error_handler": {
"name": "childJob",
"summary": "in dolore",
"description": "exercitation Excepteur voluptate consequat",
"app": "velit minim anim dolore",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~1/LQu"
}
]
},
"groups": [
{
"name": "ut sed ipsum consequat cupidatat",
"provenance": "occaecat dolore"
},
{
"name": "fugiat",
"provenance": "ex reprehenderit"
}
],
"type": "operation",
"nodeLocation": {
"x": 7480274.211516887,
"y": -71065609.97255498
},
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "dolore sint elit",
"provenance": "mollit voluptate reprehenderit"
},
{
"name": "dolore eiusmod",
"provenance": "aute"
},
{
"name": "occaecat nostrud",
"provenance": "reprehenderit"
},
{
"name": "in sunt",
"provenance": "eu id"
},
{
"name": "minim culpa ipsum reprehenderit qui",
"provenance": "Lorem et velit mollit incididunt"
}
],
"_id": "29c7b43b-a293-cb19-731a-ff68e30fd712",
"namespace": null,
"description": null,
"preAutomationTime": -39942506.30841582,
"sla": 89611874.00298679,
"errorHandler": null,
"font_size": 12,
"created": "2022-12-28T16:44:12.1Z",
"created_by": null,
"createdVersion": "minim adipisicing irure fugiat ipsum",
"last_updated": "2015-10-31T20:51:02.975Z",
"last_updated_by": {
"username": "in quis est",
"provenance": "amet fugiat voluptate exercitation in"
},
"lastUpdatedVersion": "cupidatat in sint",
"tags": [
{
"_id": "6EbBce60545F1b3f3BC3dcC7",
"name": "sint incididunt ea laborum",
"description": "ipsum et"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/~1"
},
{
"type": "encryption",
"pointer": "/~0/~1/~0/~1/~1/~0/XWQ2hfp1l/KrnG"
},
{
"type": "encryption",
"pointer": "/Y/~0/~1/d./YvueyG/xBBaP6b/JGpb54.4O/~0"
}
],
"migrationVersion": 84768825
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"title": "workflow",
"$ref": "workflowDocumentAll"
}
},
"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"
}
}
}
}