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": [
"9c11a3c65c23142ccad2d9c7",
"9480b3c424bda48b35954fe3"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"ee8da3b37b96e4739d2163de",
"1c3c656598d0a5e955b4445b",
"a66079b930160ed424d21e98",
"e3e0bde201868600851384e3",
"02983d49e4fe6f06de291bcf"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "enim ad nostrud voluptate velit",
"description": "aliquip non irure ex",
"app": "tempor proident",
"variables": {
"error": ""
},
"groups": [
"8ff5cb4b28fcf832dc8c3e4f",
"c67bba8f28624443a646c0e5",
"c55edf4a064776119659cbad"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"error",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"b923728e3a03938d022fcc85",
"fe6ff013875a29cb291d35ff",
"d61d7eeaf0425c4066e6e72a",
"b9c0c7451897036a12e13482",
"6791c4c5302f01023289ef9c"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "ullamco in ad",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1945-12-01T12:09:01.079Z",
"created_by": "858489a51f350ed2dcaebe0b",
"last_updated": "1988-06-12T11:35:34.464Z",
"last_updated_by": "620a223c172ff369a6de92db",
"lastUpdatedVersion": "nisi",
"tags": [
"Lorem",
"labore commodo"
],
"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"
}
}
}
}