Summary
Replaces a component group document.
Description
Replaces a component group document.
Route
PUT /automation-studio/component-groups/:id
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
Component group id. |
| update |
object |
yes |
Complete component group definition to replace the existing component group document with. May not contain field '_id'. |
Copied to Clipboard
{
"update": {
"name": "test",
"gbacRead": [
"veniam tempor",
"Duis",
"consequat commodo",
"Excepteur consectetur"
],
"members": [
{
"path": [
"mollit velit laboris tempor Lorem"
],
"type": "folder"
}
],
"_id": "E9adCF5cbEcEBAa280beeAaC",
"version": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"update": {
"title": "update",
"description": "Complete component group definition to replace the existing component group document with. May not contain field '_id'.",
"$ref": "componentGroupUpdate"
}
},
"required": [
"update"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Response object. |
Copied to Clipboard
{
"updated": {
"name": "test",
"gbacRead": [
"proident veniam",
"qui ex reprehenderit",
"veniam quis",
"dolor ipsum consequat",
"deserunt dolor nostrud in sunt"
],
"members": [
{
"path": "adipisicing culpa",
"type": "component",
"sourceCollection": "incididunt nisi minim nulla tempor",
"ref": "et in laborum laboris tempor"
},
{
"path": "voluptate ex consequat aliquip",
"type": "component",
"sourceCollection": "velit",
"ref": "Excepteur ipsum amet incididunt do"
},
{
"path": "in nulla aute Duis",
"type": "component",
"sourceCollection": "ut sunt consequat irure",
"ref": "ad cillum aliquip"
},
{
"path": "sit qui magna Ut do",
"type": "component",
"sourceCollection": "reprehenderit Ut consequat amet",
"ref": "deserunt dolor occaecat enim tempor"
},
{
"path": "velit enim in eiusmod incididunt",
"type": "component",
"sourceCollection": "in",
"ref": "et deserunt ex veniam"
}
],
"_id": "C3aEE09A444cDC284adFb9cb",
"description": "reprehenderit",
"gbacWrite": [
"quis et minim aliquip cupidatat",
"velit Excepteur mollit ea eiusmod",
"dolor ipsum aliquip",
"proident dolor velit"
],
"version": 1
},
"edit": "eiusmod"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"updated": {
"description": "Component group document after applying the update.",
"$ref": "componentGroup"
},
"edit": {
"type": "string",
"description": "URI to the edit page for the updated component group."
}
},
"required": [
"updated",
"edit"
]
}
