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": "Excepteur",
"description": "ea in",
"app": "veniam",
"variables": {
"error": ""
},
"groups": [
"9e39dd80d7bed95a90df735a",
"d13553b0d029d8381134f72d"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"error",
"error",
"error",
"success"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"ccb5e2e0bf2d9c72a425a326",
"266c3abd83fe8601271879a2",
"07b302c8ef66694b7deca0ef",
"4b09f090dc4d5c4a23407c66"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "irure elit laboris",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1982-01-14T07:02:11.737Z",
"created_by": "0261128d768455a4c92d1c33",
"last_updated": "1973-01-19T22:32:06.56Z",
"last_updated_by": "ae0a037504926343b273d815",
"lastUpdatedVersion": "ipsum incididunt culpa pariatur",
"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"
}
}
}