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": [
"anim velit enim dolore laboris",
"aliqua reprehenderit exercitation",
"in dolore dolore non cupidatat"
],
"members": [
{
"path": "sint veniam culpa",
"type": "component",
"sourceCollection": "aliqua",
"ref": "dolor nostrud ea deserunt"
},
{
"path": "ut fugiat dolore",
"type": "component",
"sourceCollection": "adipisicing ipsum Lorem aliquip labore",
"ref": "incididunt magna"
},
{
"path": "adipisicing irure minim est sunt",
"type": "component",
"sourceCollection": "enim amet",
"ref": "ipsum nostrud fugiat"
},
{
"path": "nostrud",
"type": "component",
"sourceCollection": "consectetur ipsum eiusmod",
"ref": "pariatur Excepteur deserunt exercitation"
},
{
"path": [
"officia veniam ad occaecat"
],
"type": "folder"
}
],
"_id": "A7cB70a778b35a5F2bfcD39D",
"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": [
"nostrud proident nulla anim",
"do nulla ea Duis",
"Duis enim quis",
"id ut",
"esse et nostrud"
],
"members": [
{
"path": "officia dolor",
"type": "component",
"sourceCollection": "ad Excepteur",
"ref": "dolore"
},
{
"path": "et",
"type": "component",
"sourceCollection": "sint nisi Ut mollit incididunt",
"ref": "nulla"
},
{
"path": "sunt nulla Ut et",
"type": "component",
"sourceCollection": "veniam",
"ref": "ad Lorem irure"
},
{
"path": "est sint",
"type": "component",
"sourceCollection": "incididunt cillum do ex dolor",
"ref": "dolore Excepteur"
},
{
"path": "aliqua enim",
"type": "component",
"sourceCollection": "dolore quis culpa",
"ref": "labore amet culpa cupidatat"
}
],
"_id": "ceAEDbCB6a0798A8Dc938e3D",
"description": "do reprehenderit nostrud ea sunt",
"gbacWrite": [
"minim est",
"proident magna Ut et",
"Ut"
],
"version": 1
},
"edit": "ut commodo veniam nulla quis"
}
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"
]
}
