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": "minim reprehenderit",
"provenance": "eiusmod veniam sunt proident"
},
{
"name": "cupidatat non est et sint",
"provenance": "veniam Duis ullamco"
},
{
"name": "esse proident",
"provenance": "amet"
},
{
"name": "Duis aute",
"provenance": "Ut exercitation ipsum officia"
},
{
"name": "Ut",
"provenance": "enim pariatur minim dolore"
}
],
"x": 13140166.839314476,
"y": -73770787.7401196
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
{
"name": "sint officia non",
"provenance": "cillum consectetur enim esse"
},
{
"name": "consequat eu sit",
"provenance": "do in tempor"
},
{
"name": "dolor velit mollit exercitation",
"provenance": "amet exercitation"
}
],
"x": 11718743.36506109,
"y": -71344155.00915834
},
"error_handler": {
"name": "childJob",
"summary": "aliqua dolore sit nulla pariatur",
"description": "reprehenderit consequat ut",
"app": "aute minim irure in",
"variables": {
"error": "",
"decorators": [
{
"type": "encryption",
"pointer": "/odSz,/GrKx7KY9.TO/FwQ4p3GchJ/pjDqrsx/~1/xZI+8+Xd+"
}
]
},
"groups": [
{
"name": "qui proident ut sunt anim",
"provenance": "exercitation"
}
],
"type": "operation",
"nodeLocation": {
"x": 87017321.76632228,
"y": 15396055.562258318
},
"deprecated": true,
"scheduled": false
}
},
"transitions": {},
"groups": [
{
"name": "occaecat cupidatat eiusmod",
"provenance": "aute ut consectetur"
},
{
"name": "dolor nostrud exercitation consectetur tempor",
"provenance": "adipisicing"
},
{
"name": "dolore non proident velit",
"provenance": "aute esse do consectetur"
},
{
"name": "esse",
"provenance": "esse nostrud Duis enim"
}
],
"_id": "0df098fd-c7d0-7727-71da-ecdcbbaf09ce",
"namespace": null,
"description": null,
"preAutomationTime": -86540573.98611169,
"sla": 28878471.295074165,
"errorHandler": {
"type": "sed ea elit culpa quis",
"name": "in incididunt laborum est anim"
},
"font_size": 12,
"created": "1985-05-11T08:59:02.474Z",
"created_by": {
"username": "Excepteur",
"provenance": "deserunt est ea magna laboris"
},
"createdVersion": "dolor qui Lorem",
"last_updated": "2010-01-31T10:58:21.097Z",
"last_updated_by": null,
"lastUpdatedVersion": "qui fugiat",
"tags": [
{
"_id": "EbA6acc8e9f5186DdDa620a7",
"name": "ea exercitation fugiat incididunt",
"description": "pariatur labore ut"
},
{
"_id": "Af07f8b586B462371b0033FA",
"name": "consectetur nulla",
"description": "laboris sint nostrud Lorem reprehenderit"
},
{
"_id": "14fA9FB492bAeEAc152fFd2f",
"name": "laborum Ut laboris ut anim",
"description": "voluptate reprehenderit commodo anim"
}
],
"canvasVersion": 3,
"encodingVersion": 1,
"decorators": [
{
"type": "encryption",
"pointer": "/YonpefUSpvy"
}
],
"migrationVersion": 71291895
}
}
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"
}
}
}
}