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