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": [
"c4f48e1bb7fcb6d325f450ad",
"a75eb14ef3e9aff39e27f9ad",
"f03faf375ed749a3a25d657f"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"83442e8105f372921fbbcd71",
"f441b212cc39c03696543ca3",
"b51f9cfaf62e7f37722f8cdf",
"9d2bc162bdbe1dfac7cb14cf",
"01bdf02547538528fcc5ab74"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "anim ut enim",
"description": "veniam anim consectetur",
"app": "laborum fugiat nisi",
"variables": {
"error": ""
},
"groups": [
"d0d342d5b4a39a7607ec6a94"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"error",
"success",
"failure"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"64044efe3f3aff4085839f82",
"8049f2d5b6d79328ab9cc93f",
"824822f2774bb8dd81ea30da",
"a28c115738e3d4fa3dae5b0d"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "2009-11-21T18:37:49.704Z",
"created_by": "ede94b4a5b9ea7ce0d0b35bc",
"last_updated": "2008-04-29T06:25:56.458Z",
"last_updated_by": "6259ebe769708e05710fd85d",
"lastUpdatedVersion": "mollit laboris voluptate sint est",
"tags": [
"ut dolore occaecat dolor",
"aliquip aute ad Ut",
"eiusmod fugiat in"
],
"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"
}
}
}
}