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": [
"412f014c55ee3eda4211c6da",
"13e85293bee6ce73e98e1c6d",
"e5b0e2375a29c62a68332d75",
"9c50aae241db03a1432e9942",
"7f6801827389b3c938644364"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"936a35d6e5c7d28500be183e",
"e9316b41a7f37973cd7932d1",
"20bad47ee8e138ccf482bc5f",
"59e1ca837ea1b399932c1e8b",
"cf98efe83517a40c27fbadc6"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "ut magna",
"description": "laboris sed",
"app": "dolor nisi",
"variables": {
"error": ""
},
"groups": [
"f96542c90266f4c806025434",
"3b2c226e241c441c3e2b47e2"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"failure",
"failure"
],
"autoRetry": false,
"limit": 10,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"43bbf769511f0260fbdebaec",
"592bdc0b251fd851cccb64a0",
"9cd4b291e5fd2789aafb4c1e"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 5000,
"font_size": 12,
"created": "1959-01-16T21:32:06.323Z",
"created_by": "6d274980a10be1f3d07db2c3",
"last_updated": "1958-09-08T03:28:47.827Z",
"last_updated_by": "184f4199ec57c944032d65aa",
"lastUpdatedVersion": "ut Excepteur eu",
"tags": [
"consectetur",
"laborum irure ex ut",
"enim tempor nostrud cupidatat in",
"qui enim",
"id fugiat ullamco"
],
"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"
}
}
}
}