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": [
"02ffcb0f727cb7f3d9dd70b3",
"e9669b3a36ef8ae1e64c9bed",
"26ac2249b812823f088f9bcf",
"f69478a6aeaa0528bb2d17cd"
],
"nodeLocation": {
"x": 33836674.855883956,
"y": -70133292.42062047
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"1daadb198e97ddf0829874ff",
"05f99a7499842962d1e31f7e",
"a6d4442390e11533c43b9193",
"c59af103b4726adc968095b8"
],
"gridCoordinate": {
"x": -2585378.358763531,
"y": -19216712.26666279
}
},
"error_handler": {
"name": "childJob",
"summary": "veniam in cupidatat",
"description": "laborum qui",
"app": "Lorem velit sint in deserunt",
"variables": {
"error": ""
},
"groups": [
"68c9c6dc14948b1c40bb6a80",
"7190923bad643f7d87d9d9dd"
],
"type": "operation",
"deprecated": false,
"scheduled": true,
"retrySettings": {
"state": [
"success",
"success",
"error",
"error",
"error"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"437b873e2bc4f954912bdefc",
"e9fe92c56f3e020957a5c453",
"6cd7d719c9cf7d0a4be49dd3",
"6bbd6ec4c4b556985a6c156c"
],
"_id": "4321abcdef694aa79dae47ad",
"namespace": {
"type": "project",
"name": "exercitation id est ipsum velit",
"accessControl": {
"read": [
"voluptate ut et in",
"consequat proident incididunt",
"amet velit aliquip",
"magna cillum"
],
"write": [
"eu",
"Lorem nulla deserunt et minim",
"ad veniam dolor in",
"dolor aliquip",
"eu amet eiusmod ex"
],
"execute": [
"Ut dolor minim",
"occaecat sed reprehenderit"
],
"manage": [
"incididunt consequat culpa aliqua",
"magna sint",
"laboris veniam sit",
"eiusmod",
"labore commodo proident"
]
}
},
"description": null,
"preAutomationTime": 250000,
"font_size": 12,
"created": "2007-09-22T07:57:16.449Z",
"created_by": "0d0c68d0249099f522c6dd9c",
"last_updated": "1962-01-05T02:10:23.671Z",
"last_updated_by": "72388c8be41511cdf6397209",
"lastUpdatedVersion": "labore culpa exercitation laborum",
"tags": [
"enim amet"
],
"canvasVersion": 1,
"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"
}
}
}
}