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": [
"d2d001f7f180127b994f5ef4",
"69b685591ee02de967725990",
"607999f6a746edf96802e839",
"e3e5f76040f334529551e271"
],
"gridCoordinate": {
"x": 86274090.56981242,
"y": -40876254.05299819
}
},
"workflow_end": {
"name": "workflow_end",
"summary": "workflow_end",
"groups": [
"f20e5096545d75085a5a6ad8",
"5a7cbc8fb56abfa4ce910c63",
"af22886fca2a637695d22dfb",
"80eaf9f15da054bd979e495c"
],
"gridCoordinate": {
"x": -72809557.70084843,
"y": -55268592.17050366
}
},
"error_handler": {
"name": "childJob",
"summary": "ut sed",
"description": "ut sit",
"app": "pariatur nostrud",
"variables": {
"error": ""
},
"groups": [
"a838b0cf28310200fe805df0",
"8efe9a0c98c46fa77ea0da84",
"31b124f6fb87704a1ee5e1b8",
"1d6df4673f63f767d4d27712"
],
"type": "operation",
"deprecated": true,
"scheduled": true,
"retrySettings": {
"state": [
"failure"
],
"autoRetry": true,
"limit": 20,
"delay": 1000,
"count": 5
}
}
},
"transitions": {},
"groups": [
"03c0065d1660803ba32db28d"
],
"_id": "4321abcdef694aa79dae47ad",
"namespace": {
"type": "project",
"name": "amet",
"accessControl": {
"read": [
"laboris laborum",
"pariatur elit esse",
"incididunt",
"sunt in culpa"
],
"write": [
"ad enim dolor",
"in",
"eiusmod commodo velit cillum adipisicing"
],
"execute": [
"sunt dolor dolore exercitation dolore"
],
"manage": [
"eu sed",
"Duis",
"in tempor nisi anim",
"nulla voluptate officia consequat dolore",
"labore"
]
}
},
"description": "minim amet ex",
"preAutomationTime": 5000,
"font_size": 12,
"created": "1959-01-01T01:13:31.066Z",
"created_by": "66205623097a48e842b0a400",
"last_updated": "1967-03-26T11:09:07.179Z",
"last_updated_by": "6a22c3cf54e5b65e595c2b06",
"lastUpdatedVersion": "in laborum labore dolor",
"tags": [
"minim",
"in irure"
],
"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"
}
}
}
}