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