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": [
"8aa933e240e2e4c831c8490b",
"bf8598fee3130e89392e5669",
"899dc1b415a305953831ca8b",
"8fdd1903ffadb991c0286141",
"ad9fec81ffc027ceba3ce3fa"
],
"gridCoordinate": {
"x": -98451719.45850787,
"y": -94704711.55347812
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"55255753ee25e332f5bfc07b",
"69284589ed8ba90b7ca06bd9",
"6890755b2520c6350fa57ad7",
"8753a1366b75f7cd14b8aa77"
],
"gridCoordinate": {
"x": -35067967.10239453,
"y": 81914759.69658396
}
},
"error_handler": {
"name": "childJob",
"summary": "magna id",
"description": "voluptate dolore consectetur est Lorem",
"app": "nulla",
"variables": {
"error": ""
},
"groups": [
"f392fabcb12524b21d7cb2f5",
"c94dd5a9bc03667f07396632"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"error",
"failure",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"8d7fa2d7573670aad9a5788d",
"21e75c548e1019c8548f5d6d",
"dbba68d3df0e49097e13e91f",
"b564688ea43a3f2141e70994"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "consectetur tempor voluptate cupidatat",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1985-04-06T16:25:45.221Z",
"created_by": "ddf6eb35dc0d0be5ce2b353a",
"last_updated": "1949-04-12T06:46:12.22Z",
"last_updated_by": "cb1cbeebed0a96517c3a4c03",
"lastUpdatedVersion": "dolore deserunt laboris occaecat ea",
"tags": [
"cupidatat do",
"voluptate fugiat nisi"
],
"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"
}
}
}
}