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": [
"magna sed do",
"nulla ex",
"laborum id dolor qui",
"labore"
],
"members": [
{
"path": [
"voluptate et ullamco quis",
"dolor ad",
"amet irure est cupidatat",
"do reprehenderit officia fugiat"
],
"type": "folder"
},
{
"path": [
"ex eu aliquip"
],
"type": "folder"
},
{
"path": [
"consectetur magna est ex ullamco",
"reprehenderit Duis eiusmod",
"elit",
"velit elit in sit",
"in ut nulla"
],
"type": "folder"
},
{
"path": "do",
"type": "component",
"sourceCollection": "ea",
"ref": "anim culpa Lorem"
}
],
"_id": "96Fe3CBD75A89c639a3eEBD2",
"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": [
"Excepteur esse Ut"
],
"members": [
{
"path": "Ut",
"type": "component",
"sourceCollection": "commodo irure magna",
"ref": "id"
},
{
"path": [
"veniam"
],
"type": "folder"
},
{
"path": "ad consequat",
"type": "component",
"sourceCollection": "velit qui deserunt aute",
"ref": "exercitation in dolore sed in"
},
{
"path": [
"sed",
"esse",
"dolore ea pariatur aute irure"
],
"type": "folder"
}
],
"_id": "8b37b30aa8DF18ecDdb263Bb",
"description": "mollit sit ut reprehenderit",
"gbacWrite": [
"anim aliquip veniam id sit",
"dolor deserunt incididunt proident Ut",
"est",
"ad culpa in officia elit",
"enim occaecat eu adipisicing nulla"
],
"version": 1
},
"edit": "dolore"
}
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"
]
}
