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": "dolore laborum nostrud cupidatat",
"provenance": "pariatur sed dolore Excepteur id"
}
],
"nodeLocation": {
"x": -65008034.864034906,
"y": 23717207.14819418
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "occaecat dolor",
"provenance": "tempor Lorem"
},
{
"name": "ut ex velit ipsum",
"provenance": "reprehenderit pariatur"
},
{
"name": "dolore",
"provenance": "magna cupidatat culpa sint in"
}
],
"gridCoordinate": {
"x": 31636119.21919304,
"y": 17918091.06895195
}
},
"error_handler": {
"name": "childJob",
"summary": "non",
"description": "sunt dolor",
"app": "do occaecat ut ea",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/KP5/pLRsGfiIBJ/Pu/Q5m7qIBur7t/j87iZeWf/~1/CQPMjU/aocxFbv4J/qrL5MfqK96V/~0"
},
{
"type": "encryption",
"pointer": "/N/~0/i/TkOz6qd/XBFRhl3xYh5/~1"
}
]
},
"groups": [
{
"name": "reprehenderit mollit Excepteur est sunt",
"provenance": "dolore"
},
{
"name": "elit velit do in",
"provenance": "aliqua Lorem nostrud dolor"
}
],
"type": "operation",
"x": 36863318.889805496,
"y": 57674986.5229066,
"deprecated": true,
"scheduled": true
}
},
"transitions": {},
"groups": [
{
"name": "et",
"provenance": "officia ex dolore cupidatat eiusmod"
},
{
"name": "laboris incididunt",
"provenance": "dolore dolor consectetur in cupidatat"
},
{
"name": "nisi",
"provenance": "amet"
},
{
"name": "in velit Lorem nulla labore",
"provenance": "consequat ea exercitation est reprehenderit"
}
],
"_id": "3fe6e378-71da-48fd-2063-19a32c1cca80",
"namespace": null,
"description": "ad",
"preAutomationTime": -72728198.1199658,
"sla": 76715200.98931906,
"errorHandler": null,
"font_size": 12,
"created": "1994-03-12T01:30:14.943Z",
"created_by": null,
"createdVersion": "cillum proident",
"last_updated": "1955-03-13T10:01:36.685Z",
"last_updated_by": null,
"lastUpdatedVersion": "qui elit dolor culpa ex",
"tags": [
{
"_id": "F02AF4FAA03D6d42ABc4dAFF",
"name": "ut veniam Excepteur culpa",
"description": "ut dolore voluptate exercitation"
},
{
"_id": "D63a6eC5d043cD003B8A5bDD",
"name": "est labore sint magna enim",
"description": "labore do velit cupidatat"
},
{
"_id": "b2EEC8Cff9FEf51Bba81E6be",
"name": "culpa sunt et incididunt",
"description": "sunt"
},
{
"_id": "0eaFD3021DAC7B33373ef62c",
"name": "sed nostrud",
"description": "eiusmod"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/wWqQly5Dh/~1"
},
{
"type": "encryption",
"pointer": "/~1/rre/d1kCFdKJ.4/~0/r/WyUrQ,8RH-n/~0/~1"
},
{
"type": "encryption",
"pointer": "/tmRY9lQOi/i1CcxW"
},
{
"type": "encryption",
"pointer": "/WO0LfC.RQz/~0/~0/Z//~0/NVb/~0"
}
],
"migrationVersion": 6705358
}
}
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"
}
}
}
}