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": [
"bba47a90568818cc767806c6",
"0b162a51dca29cf54d95c139"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"95d5ba1254bf5c10265bd03e",
"654139937167959321eb8a89",
"147756d5f49f5e7406a8d5ea",
"78cc426d6ca4c8b13c93de65",
"532ca9110b67b4df4bdc3ac6"
],
"x": 0.36142061281337046,
"y": 0.502092050209205
},
"error_handler": {
"name": "childJob",
"summary": "culpa laborum consectetur cillum",
"description": "culpa laboris ut",
"app": "exercitation ex",
"variables": {
"error": ""
},
"groups": [
"c43f1ff9f077462fadd50950",
"9abffc70814c0934684c1f0e",
"b3034b2ae22ac962774f262b"
],
"x": 0.36142061281337046,
"y": 0.502092050209205,
"type": "operation",
"deprecated": false,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"fa93bf4792605e28cb3244eb",
"c66990ba055e8389ed4f779f",
"3ead936cc8a461c8ff25f4f7",
"7853468a60c9c9375903abd2",
"7c56f46020253940ec62e9a4"
],
"_id": "4321abcdef694aa79dae47ad",
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "1987-09-26T08:22:35.188Z",
"created_by": "e63c94b8f68363ec6cd278c7",
"last_updated": "1994-05-16T17:41:58.028Z",
"last_updated_by": "6bdc992cc967d4f8ab8c053c",
"lastUpdatedVersion": "dolor nulla",
"tags": [
"irure sint",
"ex nisi amet minim quis",
"anim consectetur in incididunt sunt",
"ipsum incididunt veniam consectetur sed"
],
"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"
}
}
}
}