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": [
"commodo tempor eu in sint",
"ad amet ut anim",
"adipisicing sed laborum",
"irure veniam"
],
"members": [
{
"path": [
"Ut adipisicing eu laboris do",
"dolore",
"est sunt mollit"
],
"type": "folder"
},
{
"path": "aute",
"type": "component",
"sourceCollection": "dolor",
"ref": "in sunt"
},
{
"path": "in ad fugiat et",
"type": "component",
"sourceCollection": "sunt",
"ref": "fugiat laboris esse dolor"
},
{
"path": [
"dolore minim",
"est ea nostrud labore"
],
"type": "folder"
}
],
"_id": "AeaF3BBDafcF136D05414bDE",
"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": [
"exercitation cupidatat ex dolore culpa"
],
"members": [
{
"path": [
"in dolore ut",
"Lorem"
],
"type": "folder"
},
{
"path": [
"cupidatat et aliquip pariatur",
"voluptate exercitation aliquip dolor",
"ipsum sint dolor do",
"elit cillum deserunt ex dolore"
],
"type": "folder"
},
{
"path": "esse reprehenderit dolor",
"type": "component",
"sourceCollection": "quis",
"ref": "dolore culpa sed in"
},
{
"path": [
"deserunt dolore Ut consequat",
"ipsum",
"ut laborum consequat"
],
"type": "folder"
}
],
"_id": "cCF88A82B1693E000EeBfeFF",
"description": "eiusmod",
"gbacWrite": [
"commodo"
],
"version": 1
},
"edit": "quis dolore amet minim"
}
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"
]
}
