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": "tempor velit",
"description": "cillum nulla sit ullamco",
"app": "adipisicing anim consequat in id",
"variables": {
"error": ""
},
"groups": [
"7a300cc65557ab6f74520ef3",
"2a682248d5987bc242c1344c",
"198aafaca48dc44db104852b",
"8e0474891875a91a172991dd"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"error",
"error",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"11fd0e0757e052ac196fbe4d",
"a00f1ffa0d8f41053a2f2d66",
"99d007b8056fea458d7572ad"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "in laborum ut incididunt",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1958-02-01T15:41:40.921Z",
"created_by": "cd71e1c4c0c8d5947c6b3dfa",
"last_updated": "1964-06-03T22:26:41.974Z",
"last_updated_by": "1844a3ffae89ea5fa1988896",
"lastUpdatedVersion": "sit",
"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"
}
}
}