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 occaecat veniam",
"provenance": "voluptate elit consequat"
},
{
"name": "voluptate cillum",
"provenance": "ut dolore eiusmod"
},
{
"name": "incididunt",
"provenance": "consectetur id labore"
}
],
"gridCoordinate": {
"x": 81186863.774073,
"y": 88723898.37964535
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "Lorem aliqua ut Ut",
"provenance": "elit occaecat in Ut sit"
},
{
"name": "aute cillum Duis",
"provenance": "Lorem do"
}
],
"x": 3019914.932932183,
"y": 53604721.26031214
},
"error_handler": {
"name": "childJob",
"summary": "non ea in amet pariatur",
"description": "amet pariatur minim nulla dolor",
"app": "nulla labore",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/~1/~0/~1/kX/F1DXva/Nw/~0/MhuUrKUuc/LWTvaOE2"
}
]
},
"groups": [
{
"name": "nulla laboris ut aliqua velit",
"provenance": "nisi ipsum ex tempor"
},
{
"name": "sunt",
"provenance": "aute anim nostrud"
}
],
"type": "operation",
"gridCoordinate": {
"x": -95175138.688007,
"y": -16834644.92207922
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "aute minim",
"provenance": "ut incididunt Duis adipisicing quis"
},
{
"name": "aliqua mollit exercitation tempor in",
"provenance": "laboris non eu culpa"
},
{
"name": "est ullamco sunt eiusmod",
"provenance": "ut"
}
],
"_id": "06fc24fe-e6ac-ad62-91c2-229ea85b6693",
"namespace": null,
"description": "nulla tempor Duis",
"preAutomationTime": 11448483.172446936,
"sla": -98079043.18750347,
"errorHandler": null,
"font_size": 12,
"created": "1949-12-31T11:30:17.362Z",
"created_by": {
"username": "eiusmod in",
"provenance": "aute culpa minim consectetur"
},
"createdVersion": "ad mollit eu",
"last_updated": "2010-01-23T18:03:36.275Z",
"last_updated_by": {
"username": "occaecat nostrud",
"provenance": "proident adipisicing dolore commodo"
},
"lastUpdatedVersion": "tempor",
"tags": [
{
"_id": "e026f5e67E5C6E34ca1Fb6AE",
"name": "ad voluptate aute adipisicing deserunt",
"description": "fugiat dolor mollit consectetur pariatur"
},
{
"_id": "66963ccD51f69181ef68CED4",
"name": "exercitation ad",
"description": "dolor esse cupidatat"
},
{
"_id": "ABEda8AF30fc424Bb8152f7E",
"name": "ea",
"description": "dolor tempor irure consectetur labore"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/~0/UP+ySS2Hz/~1/~0/MG7Ke/IlB,wmO+/x3qRueOSnEZ/~1/~1/bRw2oXXhy5/~0"
}
],
"migrationVersion": 60529638
}
}
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"
}
}
}
}