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": [
"sint qui labore elit",
"et dolore in voluptate cillum",
"ad Duis aute ut",
"et qui incididunt deserunt",
"non anim amet"
],
"members": [
{
"path": [
"nisi",
"deserunt",
"est eiusmod fugiat sed eu"
],
"type": "folder"
},
{
"path": "tempor in consequat aliqua",
"type": "component",
"sourceCollection": "voluptate",
"ref": "id eiusmod elit ipsum sint"
},
{
"path": [
"anim sunt proident",
"voluptate dolore sunt do"
],
"type": "folder"
}
],
"_id": "662e1e0Bd28e1Ae6ddd36026",
"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 laborum Lorem",
"sed aliqua cillum deserunt in",
"ut eiusmod ex velit Lorem",
"fugiat Lorem enim mollit"
],
"members": [
{
"path": [
"voluptate cillum",
"in aliqua quis pariatur"
],
"type": "folder"
},
{
"path": [
"ad eiusmod cupidatat aliqua"
],
"type": "folder"
},
{
"path": "aute irure aliquip deserunt",
"type": "component",
"sourceCollection": "sunt",
"ref": "ipsum amet cillum"
}
],
"_id": "88bDCCaa4aec5aDEB9042B15",
"description": "ipsum sunt",
"gbacWrite": [
"pariatur",
"exercitation irure amet"
],
"version": 1
},
"edit": "commodo"
}
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"
]
}