Summary
Validate a workflow
Description
Validate a workflow, and return the resulting errors and warnings arrays.
Route
POST /workflow_engine/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": [
"ac3f71a8700efde51c33f312",
"61955d5392d1f99580b90ce8",
"0a06dcfd58ee1991c5a06426",
"1107f5c42952808137fbac47",
"a73b8a3060e40955c02e25c6"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"bfeda6f38307cd5018c789a7",
"5c452fd82876c5b743db87fb"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "sunt",
"description": "dolor esse magna consectetur deserunt",
"app": "minim",
"variables": {
"error": ""
},
"groups": [
"fd7f5f205f3651d45dbc8ee6",
"f80899ab307c0371036edf27"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"bc08795a87e71c9b93af85fb",
"ac64b186c151cddb5504ac29",
"68efe57e9b35692dfe284387"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "2024-04-06T03:57:46.338Z",
"created_by": "cdd690567cc3f64e303119b4",
"last_updated": "2000-07-20T13:18:14.25Z",
"last_updated_by": "d98060b9ff6804c9506664f9",
"lastUpdatedVersion": "dolore sunt exercitation aliquip",
"tags": [
"Ut",
"consectetur ea dolore exercitation nisi"
],
"canvasVersion": 2,
"encodingVersion": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"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
{
"title": "validationResult",
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object"
}
},
"warnings": {
"type": "array",
"items": {
"type": "object"
}
}
}
}