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": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "esse fugiat culpa consectetur cupidatat",
"description": "dolor ullamco",
"app": "exercitation fugiat adipisicing dolore nisi",
"variables": {
"error": ""
},
"groups": [
"275eaf3b7571fe943ed628a9",
"2d8bcc06e611a3400af47d3c",
"0c1319b576a3f8265edcb249",
"b73be30fa2954fb828d910c9"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false
}
},
"transitions": {},
"groups": [
"9160e2b28212411d78c34c9a",
"61c866176c70257496fa50b2",
"7897e3999ed3e6422eca323f",
"e91bf013f8a1389404ece39a",
"85b96d63002cd4609a77def9"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"font_size": 12,
"created": "1984-08-28T09:58:18.095Z",
"created_by": "b1ee589844a653fda9e0e90a",
"last_updated": "1962-05-19T22:54:33.724Z",
"last_updated_by": "f5a4276a9cd87a10ac40fa81",
"lastUpdatedVersion": "in",
"tags": [],
"canvasVersion": 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
{
"type": "object",
"properties": {
"errors": {
"type": "array"
},
"warnings": {
"type": "array"
}
}
}