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": [
"6221397c115bac4ff287c4a8",
"f6377b492d3457c5e44290ae",
"283aba210ba825d44463830a"
],
"gridCoordinate": {
"x": -87331146.79460323,
"y": 47310489.62996599
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"d9cadb23f5ac0703ce70a8e1"
],
"gridCoordinate": {
"x": 38896338.58715883,
"y": 72137572.66621199
}
},
"error_handler": {
"name": "childJob",
"summary": "Lorem esse anim sed",
"description": "nostrud",
"app": "nulla amet non",
"variables": {
"error": ""
},
"groups": [
"76ccdfc43dce85594e8a5bca"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a6ff01bd27a18088af0536d1",
"c9fc437354b7e1fc86abe6d9"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "officia anim irure",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2008-09-27T22:26:59.129Z",
"created_by": "e1aaf5fe69f0dd52813ea8cf",
"last_updated": "1945-07-08T21:40:00.496Z",
"last_updated_by": "e74ba20f7520340899b64d57",
"lastUpdatedVersion": "ex",
"tags": [
"Excepteur consequat aute",
"deserunt commodo culpa",
"do consequat sint",
"dolore",
"consequat cupidatat esse eu sunt"
],
"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"
}
}
}
}