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": [
"b636f8f28147df1fe2ac2722",
"6978e1013642dc2e4a448f08",
"d1a49ea7eb1ebac6d107363b"
]
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"998f3d0570582d116375f3bd"
]
},
"error_handler": {
"name": "childJob",
"summary": "irure et",
"description": "sit dolor adipisicing voluptate",
"app": "in in",
"variables": {
"error": ""
},
"groups": [
"95993a08669a422b72378b84",
"050545c14f4ffd3421493895",
"2b486947e40330a6c4ac13de"
],
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"76a0bba29230e22557215f65",
"c0b7a1ffac6ead5273bd1bbd",
"963c3032f9d7133a5e01133b",
"1ddb2d909043dc5c7e8e5170"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "consequat voluptate",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2020-03-17T18:39:24.634Z",
"created_by": "a336b121ba5b035e6ab97559",
"last_updated": "1957-04-09T17:41:42.21Z",
"last_updated_by": "5b1011164c19603a1ef9b811",
"lastUpdatedVersion": "do fugiat ipsum",
"tags": [
"eu ipsum",
"cupidatat aute consectetur",
"sint labore ut"
],
"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"
}
}
}
}