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