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": [
"bac0cf61119884ef107fcb54",
"3c4849847530222136495814",
"24efb5469b21aaf2d5d3bfdb",
"f59b40e10e7811f4c01390ef",
"bd863357b4cb012918d36498"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"1e99a151e463a375bb289e9e",
"6986622b346345808cb1d769",
"4e77ed34affe6aa5a15aa042",
"900308530470142a5db6785e"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "elit non mollit quis in",
"description": "officia eu fugiat",
"app": "pariatur in exercitation labore",
"variables": {
"error": ""
},
"groups": [
"808fc030e4a429a6be064977"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"a4fb6924fcb785bf98d12ac8",
"2cbf0d6f530594c31b23db59",
"9df2aa19df5794e35f7a24af"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "ullamco",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1981-07-13T02:05:08.186Z",
"created_by": "ba3e013736b1f06fa11a1a5f",
"last_updated": "1951-12-13T20:33:50.043Z",
"last_updated_by": "e5e1eb33509d7559f24e8a44",
"lastUpdatedVersion": "sint in commodo",
"tags": [
"in nulla nostrud",
"ea tempor occaecat",
"id aliqua esse laboris sit",
"fugiat esse"
],
"canvasVersion": 1,
"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"
}
}
}
}