Summary
Validate a workflow
Description
Validate a workflow, and return the resulting errors and warnings arrays.
Route
POST /automation-studio/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": [
"cbf3cf17b80a63e2a8b53774",
"1bdfbcacaa5be37539614fd5",
"3c299fee098b46b787d54919",
"05dc23d24f08d3e76f2c39b1",
"8a90c8fdd51153827db18196"
],
"x": 76194641.70164275,
"y": 89084799.73808205
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"157856a03dd9cd4b22a28cba",
"0e9bfe2d38a83a4c99723467"
],
"x": -59299853.5731299,
"y": -61870991.900847815
},
"error_handler": {
"name": "childJob",
"summary": "sit dolor in quis ut",
"description": "elit laboris eiusmod veniam Duis",
"app": "esse ut eiusmod",
"variables": {
"error": ""
},
"groups": [
"08db58622e4f19f53d81f9a6",
"a8fbb973e5fed13092252409",
"28b62bc10c09d3cbba7869e3"
],
"type": "operation",
"deprecated": true,
"scheduled": false,
"retrySettings": {
"state": [
"error",
"error",
"success",
"success",
"failure"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"055882c634b429abda145f9a",
"7c0a590d73072fd02f3b7077",
"e7a6a8150956a4362d4ad499",
"f1263c7af885fd1c9b53b44d"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "ad",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1986-01-14T03:16:59.111Z",
"created_by": "391520cd13ffed46a809a54c",
"last_updated": "1979-05-01T18:06:40.299Z",
"last_updated_by": "e4858cdb926593c3b564a41d",
"lastUpdatedVersion": "nisi elit do",
"tags": [
"aliqua magna esse ut eu"
],
"canvasVersion": 2,
"encodingVersion": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"workflow": {
"title": "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
{
"type": "object",
"title": "validationResult",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object"
}
},
"warnings": {
"type": "array",
"items": {
"type": "object"
}
}
}
}