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": [
"cillum mollit enim reprehenderit"
],
"members": [
{
"path": "reprehenderit enim",
"type": "component",
"sourceCollection": "veniam Ut irure laboris",
"ref": "ut culpa in sed"
}
],
"_id": "ccD4bBF4822ADF6CeA0D8a2d",
"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": [
"sed Excepteur enim",
"voluptate Excepteur proident id mollit",
"enim nisi",
"sed deserunt",
"dolore"
],
"members": [
{
"path": [
"minim adipisicing",
"aute exercitation reprehenderit anim irure",
"proident",
"quis tempor esse ad in",
"velit irure dolore amet veniam"
],
"type": "folder"
},
{
"path": [
"sunt aliquip esse",
"laboris dolore",
"in officia sunt"
],
"type": "folder"
}
],
"_id": "8F60ABFb7544FA7B21b5E3f2",
"description": "cupidatat non deserunt",
"gbacWrite": [
"ea sunt",
"exercitation proident adipisicing",
"ut deserunt amet veniam sint",
"laboris sunt",
"ipsum ut"
],
"version": 1
},
"edit": "tempor Excepteur"
}
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"
]
}