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": [
"49f9f99caacd89aa03b39141",
"cb09ab6e47b9ab815c4ae45d",
"43fbdb935699f11bc811091a"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"26e3272e99a79a4df41db9d1",
"e4e9d5ef237782eb4cc9f2c8",
"b4f8d4065ce307e0e7a9dbce"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "elit anim nulla",
"description": "reprehenderit",
"app": "dolore tempor elit",
"variables": {
"error": ""
},
"groups": [
"f79975582ac499111cc40825"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure",
"failure",
"error",
"error"
],
"autoRetry": false,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"3428facd6b0b192535712899",
"49366631244d68c525dfbf6c",
"5af07fa4cdecb4e6ac8eb63d"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "nulla in",
"preAutomationTime": 5000,
"font_size": 12,
"created": "2021-02-23T23:38:08.653Z",
"created_by": "571e6f4cb6b9ef29cc3f86d9",
"last_updated": "2024-04-07T21:58:25.584Z",
"last_updated_by": "9662f5123fe49edb285c579a",
"lastUpdatedVersion": "ullamco voluptate cupidatat aliqua",
"tags": [
"incididunt tempor cupidatat",
"et fugiat Excepteur veniam"
],
"canvasVersion": 1,
"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"
}
}
}
}