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": [
"in commodo id veniam anim",
"esse deserunt",
"sed ut aute sint",
"veniam Ut in cupidatat",
"Ut nostrud ex"
],
"members": [
{
"path": "sit",
"type": "component",
"sourceCollection": "culpa voluptate ea",
"ref": "reprehenderit sunt in cupidatat veniam"
},
{
"path": "in laboris",
"type": "component",
"sourceCollection": "Ut Excepteur nostrud aliquip",
"ref": "quis Duis eu irure aliquip"
},
{
"path": "veniam Ut",
"type": "component",
"sourceCollection": "in anim dolor reprehenderit",
"ref": "sed reprehenderit dolor cupidatat"
},
{
"path": "occaecat qui",
"type": "component",
"sourceCollection": "do non incididunt",
"ref": "officia culpa"
},
{
"path": "veniam et",
"type": "component",
"sourceCollection": "nulla aute consectetur",
"ref": "nisi"
}
],
"_id": "8A7D0e163Dcb5d182d7aDdbd",
"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": [
"cupidatat anim non",
"sint",
"quis consectetur in ut reprehenderit"
],
"members": [
{
"path": [
"et in cupidatat",
"magna consectetur aliquip nostrud dolor"
],
"type": "folder"
},
{
"path": "est consequat consectetur eu anim",
"type": "component",
"sourceCollection": "Excepteur magna",
"ref": "eiusmod in"
},
{
"path": "non Lorem sunt",
"type": "component",
"sourceCollection": "ut voluptate",
"ref": "in sit adipisicing amet"
}
],
"_id": "eA6C49786aEcE1Aa2a35995D",
"description": "officia voluptate ipsum enim",
"gbacWrite": [
"cillum laboris sint",
"nostrud anim consequat minim mollit",
"in",
"nisi Lorem sit"
],
"version": 1
},
"edit": "Duis commodo id pariatur officia"
}
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"
]
}
