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