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": [
"7111d7c78ea5a598799ecb9e",
"2fb8f73ad9f01a90cf46fb85",
"2be75aeeacb0024fc4f48a4c",
"f4afe04320a96fb4a0d9a9d2",
"359121046d3289ea154cdcbf"
],
"nodeLocation": {
"x": 2606270.449957162,
"y": 28047713.67736429
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"87d1f3ed004e84bb7497f45a",
"1233bb67e6275505cc73c3f0",
"37e139abfe0ca9c730f940bf",
"7539b473343983a04dec1ff3",
"e0f302e440447624f7c76de7"
],
"x": -86587250.00498846,
"y": 52083329.63426775
},
"error_handler": {
"name": "childJob",
"summary": "dolor anim quis",
"description": "laborum amet ut",
"app": "ipsum pariatur laboris",
"variables": {
"error": ""
},
"groups": [
"e1c4e4c74ee9505af347325a",
"980dcefa781bb17cea7c9494",
"88a14de57438a1ab2ace7377",
"375b1811885a1d10dd7aed34"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure",
"success"
],
"autoRetry": true,
"limit": 10,
"delay": 2000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"93174a552bc64a4179c4d68c"
],
"_id": "5cb7b531d06cceb89fd21b1c",
"description": "incididunt ad",
"preAutomationTime": 250000,
"font_size": 12,
"created": "2004-01-19T17:19:47.917Z",
"created_by": "b3b843ce6804ef6938e36146",
"last_updated": "1984-05-25T14:45:24.934Z",
"last_updated_by": "4143b350e811322019273714",
"lastUpdatedVersion": "incididunt veniam",
"tags": [
"ea et mollit cillum",
"Excepteur Duis ex ut quis"
],
"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"
}
}
}
}