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": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "laboris",
"description": "deserunt aliquip id aliqua pariatur",
"app": "laboris",
"variables": {
"error": ""
},
"groups": [
"bde5f6211612d60a0866964a",
"3761b6ae7aae3bc7b1556cbc",
"30bec75eca32c2a3c62fe18b",
"53c6efb89d1bee79a54dd5ff",
"21cb9808c1e969c38effb2d8"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"failure",
"failure",
"error"
],
"autoRetry": false,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"37cb337d27d6590c170ebb29",
"f63033b28659615fee82e0b9",
"d50b42a64e131f3cd5ba8e83",
"c7dc4706c977acdc47872a28",
"0593f83c2d9f0676a70d4221"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "et consequat proident exercitation veniam",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1960-09-14T03:49:49.652Z",
"created_by": "1dd84c7e1af383a5089ec82f",
"last_updated": "1968-04-17T15:54:25.121Z",
"last_updated_by": "8c219a37e383dfc2d274483e",
"lastUpdatedVersion": "elit non voluptate in ut",
"tags": [],
"canvasVersion": 2
}
}
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"
},
"warnings": {
"type": "array"
}
}
}