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": [
"aliquip commodo magna dolore",
"esse laboris sit"
],
"members": [
{
"path": [
"aliqua",
"proident tempor minim",
"sunt ut"
],
"type": "folder"
},
{
"path": [
"est",
"minim id sed mollit eu",
"occaecat nisi veniam",
"voluptate"
],
"type": "folder"
},
{
"path": [
"dolore nisi tempor",
"est",
"mollit quis cupidatat laboris",
"enim quis in"
],
"type": "folder"
},
{
"path": [
"pariatur nulla cupidatat",
"quis voluptate labore in"
],
"type": "folder"
}
],
"_id": "9Ac9C31fe08D3444FeCd33e4",
"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": [
"nostrud sunt in",
"sint aliquip minim",
"ea",
"dolore culpa fugiat",
"cillum adipisicing"
],
"members": [
{
"path": "dolor in",
"type": "component",
"sourceCollection": "officia dolore Lorem proident aliquip",
"ref": "adipisicing occaecat enim"
},
{
"path": "elit ea irure ad",
"type": "component",
"sourceCollection": "non elit",
"ref": "quis sed incididunt"
},
{
"path": [
"officia consectetur",
"eiusmod",
"tempor qui deserunt labore",
"laboris ut sed"
],
"type": "folder"
},
{
"path": [
"exercitation consequat quis elit in"
],
"type": "folder"
},
{
"path": "dolore amet tempor consequat",
"type": "component",
"sourceCollection": "esse cupidatat",
"ref": "ut"
}
],
"_id": "45dfC568606Cccc9e21bFB8c",
"description": "aute",
"gbacWrite": [
"ullamco exercitation do",
"cillum dolore",
"do in"
],
"version": 1
},
"edit": "aliqua ut dolore 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"
]
}
