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": "anim magna ut sint eu",
"description": "ullamco ipsum veniam",
"app": "minim ea",
"variables": {
"error": ""
},
"groups": [
"9719e5d8772671808956b8e2",
"f31ab84b37ceb97cca8f1afa",
"c03698f0d47f22fd45954793",
"f20fb733b63b5ef6bde339f3",
"d2b4f01b0a3e003462a30ca7"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"success",
"failure",
"error",
"success"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"50a9439a570c6a76e92179e5",
"42ea16e244c5153856949966",
"5f0cf06c8f01d127f7325940",
"5bd476c2af6a1a885cb640c8"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "in officia nisi",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2008-10-12T19:28:35.766Z",
"created_by": "58f766c4c1a68aa3a8ad2dc4",
"last_updated": "1992-03-05T18:05:50.069Z",
"last_updated_by": "617801473af2fbbcfa30c30d",
"lastUpdatedVersion": "laborum occaecat",
"tags": [],
"canvasVersion": 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"
},
"warnings": {
"type": "array"
}
}
}