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 sunt sed in",
"pariatur",
"velit",
"laborum proident"
],
"members": [
{
"path": "Duis ut aliqua",
"type": "component",
"sourceCollection": "voluptate commodo Ut",
"ref": "Excepteur"
},
{
"path": [
"veniam ut"
],
"type": "folder"
},
{
"path": "exercitation in",
"type": "component",
"sourceCollection": "in est sint anim in",
"ref": "laborum cillum"
}
],
"_id": "A07e1B658bFBDfAcdeCFB6A1",
"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": [
"pariatur consectetur",
"Lorem ipsum aute ut",
"anim do pariatur exercitation",
"in nostrud pariatur Ut",
"ex"
],
"members": [
{
"path": "laboris Ut",
"type": "component",
"sourceCollection": "quis magna adipisicing sint",
"ref": "esse"
}
],
"_id": "2f0cE9Faa34CAb1EA762fFD4",
"description": "incididunt",
"gbacWrite": [
"eu adipisicing",
"ad Duis dolor est"
],
"version": 1
},
"edit": "nulla deserunt ad magna consequat"
}
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"
]
}