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": [
"e0d8ea369bb9672ed033f720",
"5dc1224de5cdcb7769d16e71",
"10318d45588a07e9f67cbcb3",
"5295773cb287f45b04722c9b",
"0b21d9b69cc7280dd7856890"
],
"nodeLocation": {
"x": -7641641.897779122,
"y": -95293188.44844346
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"e30e7cce7cdcc00c41c61d57",
"884ec7164c37de3a4b67d259",
"b8977572c6b51493dbca9791"
],
"gridCoordinate": {
"x": 14795822.933464333,
"y": 61730612.46918371
}
},
"error_handler": {
"name": "childJob",
"summary": "ut id",
"description": "laborum irure pariatur consequat",
"app": "mollit non enim",
"variables": {
"error": ""
},
"groups": [
"e7ebdb22330b5a3f9c293989",
"f2eb2d48d6add41584f1d301"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success",
"error",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a4beb1bde47ce710d7a61534",
"c1a034080abab07d085ded97",
"780399d75450b7a99f27c7ee"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"namespace": {
"type": "project",
"name": "sed ut nulla",
"accessControl": {
"read": [
"Ut sit",
"culpa elit et in",
"ad adipisicing amet tempor"
],
"write": [
"in dolore minim eiusmod Duis",
"Duis consectetur elit",
"Lorem ex aute do mollit",
"est laborum in ut ad"
],
"execute": [
"quis aute qui",
"commodo"
],
"manage": [
"minim",
"adipisicing exercitation"
]
}
},
"description": "Duis veniam reprehenderit",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1961-03-01T01:24:36.04Z",
"created_by": "0cd03c0896c6931de5e94fd1",
"last_updated": "1979-08-05T17:16:13.898Z",
"last_updated_by": "c9617affd4549d6969a5c58c",
"lastUpdatedVersion": "incididunt dolor",
"tags": [
"ex enim amet reprehenderit eiusmod",
"Excepteur deserunt"
],
"canvasVersion": 1,
"encodingVersion": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"title": "workflow",
"$ref": "workflowDocument"
}
},
"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"
}
}
}
}