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": [
"69bde6f8c7d58f9e0069cdb0",
"6601046afcca769d2c44fad1"
],
"nodeLocation": {
"x": -62153012.81200043,
"y": -28739891.27761303
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"1649323ca956dfefd0e7e122",
"f35b50c6fb862e587913e79c",
"b43f9e48b1486565763bf08b",
"8114cd6565daf09e1096c93d"
],
"nodeLocation": {
"x": 74406817.37455708,
"y": -58174293.59126262
}
},
"error_handler": {
"name": "childJob",
"summary": "magna",
"description": "Excepteur velit Ut in",
"app": "labore commodo pariatur aliqua",
"variables": {
"error": ""
},
"groups": [
"bb57f3276155fce12940f683",
"7f2436a999821beb8dec05f9"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"0e728f238ad1eef6583922e7"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1979-03-28T12:10:33.022Z",
"created_by": "cb9740d8481c825996e0a8d0",
"last_updated": "1992-07-06T01:35:47.174Z",
"last_updated_by": "1be704f0d53e042936603dc0",
"lastUpdatedVersion": "do sit nisi",
"tags": [
"cupidatat occaecat aliquip",
"est"
],
"canvasVersion": 2,
"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"
}
}
}
}