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": [
"601af6db9f9d9b00a35085fa",
"ed082c47ca4752031f983bf2",
"3a40b952bcc99bba08dff6fa",
"be2059394b83bed674c0f903",
"cb99156008918649c25855d4"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"05e2ee30cc66768365938e61",
"2184b220ab5de240d3f790ea",
"c5d89425c98248662181823c",
"106f3c941c9628adc44a82a1",
"20051bb439719c4ef32c5ffd"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "ut anim",
"description": "ad magna nisi",
"app": "exercitation tempor cillum id",
"variables": {
"error": ""
},
"groups": [
"c2af9381416285d94ea4127e",
"b2d30d3e77fff5138d1f8766",
"9471d4e997710830499a710b",
"0d47492278818599be78fe1f",
"40a3fa3dcd5a1d3288793a69"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"failure"
],
"autoRetry": false,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"3084e5ab440fad70c999662a"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1971-09-08T12:55:53.453Z",
"created_by": "c95046c1e1c36b7dc099d1b1",
"last_updated": "1989-03-04T20:28:37.335Z",
"last_updated_by": "f360758a1efc5868cb0fda05",
"lastUpdatedVersion": "ut Ut esse",
"tags": [
"dolore aliqua nostrud",
"consequat magna tempor non"
],
"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"
}
}
}
}