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": [
"3b4a1aeb74e8f274298ad78f",
"61292f0d58db6545a31f1de1"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"e7df8cbb7e366b5f37f6f0cb",
"c2a2349954965b6b36858a7b",
"f1136d202675f289d488c002"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "officia ea ut aliquip enim",
"description": "eu sed non sunt occaecat",
"app": "magna",
"variables": {
"error": ""
},
"groups": [
"583e072e71c7528598a2c836",
"82e3b6f79e0c0c71d3fe6398",
"49812225e05eabd11ea210e5"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"failure",
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"c7dc8d3864bd047f328fc7b0",
"9a0b451292755895f3266bfd",
"86ba1ed3f7450555a5834632",
"8bbee4667b27541f1c4de8fd",
"df9ea70136c5f106c1183c78"
],
"_id": "4321abcdef694aa79dae47ad",
"description": "in dolor Ut",
"preAutomationTime": 250000,
"font_size": 12,
"created": "1996-03-11T20:56:03.276Z",
"created_by": "b7c28de4480757b66baba1a6",
"last_updated": "2019-04-24T16:05:44.154Z",
"last_updated_by": "f1c2e5891e315551323acb97",
"lastUpdatedVersion": "ut aliquip ut sed",
"tags": [
"fugiat veniam est ut anim",
"sed Excepteur",
"Excepteur pariatur",
"exercitation ut id"
],
"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"
}
}
}
}