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": [
"5eb93c71b7d08957abd182bf",
"e95f8cdc20bc474ada4796b8"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"72076d8224e3d1d24a1e3713",
"0aaf7d283439993a12b0406a",
"85bcd6d6c7727d86893d5566",
"c6f92501b34eb5c3cc42540e",
"41df5fe4fcb3b9dbbf1cffd0"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "laborum cupidatat",
"description": "proident voluptate pariatur est magna",
"app": "eu Excepteur labore ut qui",
"variables": {
"error": ""
},
"groups": [
"ab62efedaa9e429fc44b4070",
"67915762977ada2ccae037cd",
"05827b37e10879ec28959617",
"2140d494b61be5d236d83e63",
"eaf0c40138cab4b2fac27ec9"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"6a01c499233e6421313ed52b",
"a223bfbdd20f7543b0a9ae40"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "2019-10-31T11:56:45.914Z",
"created_by": "7d02179f24ea2ab6bf6d3236",
"last_updated": "1948-09-14T08:15:46.834Z",
"last_updated_by": "627bcf6eb299a05bc48bb695",
"lastUpdatedVersion": "Lorem quis magna consectetur",
"tags": [
"ut in deserunt eu incididunt",
"do",
"sint",
"dolor aliqua sint"
],
"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"
}
}
}
}