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": "anim",
"provenance": "dolor dolore anim quis commodo"
},
{
"name": "nisi ullamco occaecat in",
"provenance": "anim Excepteur mollit"
},
{
"name": "ad dolor eiusmod sint deserunt",
"provenance": "eu"
}
],
"gridCoordinate": {
"x": 80630450.0153884,
"y": 54280658.696468085
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "sed",
"provenance": "cillum veniam Lorem"
}
],
"gridCoordinate": {
"x": 13789981.548549026,
"y": 56891712.76447201
}
},
"error_handler": {
"name": "childJob",
"summary": "occaecat veniam enim",
"description": "Excepteur ut sed ea et",
"app": "consectetur",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/N/t7e/uAQkq/r,/frC1Bw9/~0/~0/jvV"
}
]
},
"groups": [
{
"name": "cillum",
"provenance": "non cupidatat in dolor occaecat"
},
{
"name": "do dolore sed dolor",
"provenance": "commodo sunt"
},
{
"name": "aute laboris ipsum",
"provenance": "occaecat"
},
{
"name": "id pariatur in",
"provenance": "deserunt et nisi sint aliqua"
}
],
"type": "operation",
"gridCoordinate": {
"x": -7703488.543453574,
"y": -6690768.2993863225
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "Duis qui dolore",
"provenance": "aliquip sunt"
},
{
"name": "quis adipisicing",
"provenance": "esse magna sit dolore incididunt"
}
],
"_id": "30e238ae-39ff-e9f1-b4f8-242a53b3ecfa",
"namespace": null,
"description": "culpa irure nostrud",
"preAutomationTime": 37601393.79326564,
"sla": 72392443.27870163,
"errorHandler": null,
"font_size": 12,
"created": "2016-03-19T02:49:41.894Z",
"created_by": {
"username": "cupidatat aliquip",
"provenance": "est aliqua"
},
"createdVersion": "id labore veniam adipisicing voluptate",
"last_updated": "1976-09-11T00:21:16.259Z",
"last_updated_by": null,
"lastUpdatedVersion": "irure Excepteur laboris",
"tags": [
{
"_id": "0AfD46747D7c5A6ca162a3ED",
"name": "elit fugiat exercitation est culpa",
"description": "irure ea"
},
{
"_id": "DeCAbaCc4Cd1EeBD1D3BfFFa",
"name": "in ut cillum aute in",
"description": "laborum nostrud eiusmod adipisicing"
},
{
"_id": "ee0f16b9C5ad59a7caFeCfbf",
"name": "ullamco et nisi",
"description": "ut voluptate do"
},
{
"_id": "6BbbEbd5D3EBc6ab5b24dAa8",
"name": "magna",
"description": "dolor non cupidatat"
}
],
"canvasVersion": 2,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/WNKSIXNkCI/VoLMomB4"
},
{
"type": "encryption",
"pointer": "/kcnl/ynY1z/xNvGnW4ijZ//~1/XW5C,/qfw.48Y+qc/eGrMnWtN/tj6A/of4,7h/X8/Iipz0L"
},
{
"type": "encryption",
"pointer": "/~1/cad/~0/l5j/EDbNV/B2s6kQTEZ/r"
}
],
"migrationVersion": 26330198
}
}
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"
}
}
}
}