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": [
"99a76a3ebf4f95206583217d",
"1d6464342718d3d28c81b112"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"16b91ad1acc653706a619952",
"48c4a34463b7681b45e565ea",
"e4d9ac5d49bd32cdf4b1eb19",
"392af5c0f77a3421cdad57c4",
"1b14899dc1151635211b797c"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "adipisicing",
"description": "fugiat",
"app": "in qui exercitation Ut eu",
"variables": {
"error": ""
},
"groups": [
"02a6f9b13b6c1fca93806217",
"9cd84b778cf0847c47770fc4",
"9528b2f159e49832bfe6937b",
"bb80a99b2b030f30f8f2f472"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"success",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"2d46648e948bd174280cab8b",
"021ab7f30106477a6c9333f8",
"be9749bf631dccaba340d908"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "elit aliquip",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1991-03-31T22:17:52.972Z",
"created_by": "00fec331683250233a66f7cb",
"last_updated": "1991-10-18T06:14:43.777Z",
"last_updated_by": "8f967ef9a7f7176a1b5d32cf",
"lastUpdatedVersion": "et labore nulla",
"tags": [
"occaecat ut magna enim"
],
"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"
}
}
}
}