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