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": [
"ffc70dbeb24d693d357ae8e1",
"6a877cecd84cd812b7475247",
"1303b8322df38f3996f093e7",
"ba01f2f35a2431942291bfc5"
],
"x": 12888503.719497234,
"y": -32831552.654060528
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"6c59b4053458c42c26fcf6af",
"a3a97a38bd3ca4daa27e2f10",
"c26f3f8d9d73452f81257c08"
],
"x": 19373535.268321037,
"y": 99119613.46297783
},
"error_handler": {
"name": "childJob",
"summary": "officia aliquip cupidatat",
"description": "culpa ea deserunt",
"app": "tempor fugiat dolore",
"variables": {
"error": ""
},
"groups": [
"33155a60086ae1495613a473",
"856f7df775f0944d97a5af81"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"error"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"3cd35ba4159afeb4107287d7",
"09cb380b66364e63918e5578"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "voluptate",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1969-06-03T22:46:31.019Z",
"created_by": "91a68b840430358797aa4511",
"last_updated": "2008-06-07T03:49:05.079Z",
"last_updated_by": "30185d65b066b91c828ad2fa",
"lastUpdatedVersion": "aliqua exercitation laboris",
"tags": [
"ut",
"et nostrud proident",
"voluptate"
],
"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"
}
}
}
}