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": [
"6f340a963e4751b0fdcffe62",
"e0da03f88141e7117f502f48",
"2f301e59f27913c150b27590"
],
"x": 51072256.556453586,
"y": 15590420.999891564
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"8b21a9f7bbd24869475b14c9",
"8509ad874f712b1334e7fb53"
],
"gridCoordinate": {
"x": -34722439.12173196,
"y": 48213884.33613393
}
},
"error_handler": {
"name": "childJob",
"summary": "culpa ea non do",
"description": "aute ut",
"app": "elit dolor in",
"variables": {
"error": ""
},
"groups": [
"074ca8a306256bb0cf85afc2"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a497d1f610a67c50c471b51a",
"c388d85bb1b17c51e365ca7f",
"de0d306ea3d73f8683b442bf",
"6e13208d33a5df5fe6a4bf8c",
"2e70ec2cacbdc87739c696ca"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "ullamco pariatur adipisicing in mollit",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1957-01-10T08:41:46.082Z",
"created_by": "4b40c7fcffa47994864080f6",
"last_updated": "2024-09-15T18:17:54.142Z",
"last_updated_by": "4c7a225f6a6d92e9b6ac3e73",
"lastUpdatedVersion": "consequat",
"tags": [
"occaecat cillum tempor proident",
"esse",
"aliquip",
"sunt laboris nisi pariatur sed"
],
"canvasVersion": 1,
"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"
}
}
}
}