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": [
"est laboris mollit dolore incididunt",
"sunt est incididunt laboris irure",
"ex elit culpa ut cillum",
"laboris",
"nulla exercitation ut cillum occaecat"
],
"members": [
{
"path": "voluptate quis reprehenderit do minim",
"type": "component",
"sourceCollection": "anim consequat qui aute",
"ref": "in mollit dolor"
},
{
"path": [
"dolore",
"ex",
"nulla mollit ullamco",
"mollit"
],
"type": "folder"
},
{
"path": [
"id aute"
],
"type": "folder"
}
],
"_id": "652e80a8Ab769b340f24f3dE",
"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": [
"sunt aliqua sit deserunt anim",
"nulla sed est",
"reprehenderit elit",
"do velit",
"nulla fugiat ipsum sint"
],
"members": [
{
"path": "labore consequat irure",
"type": "component",
"sourceCollection": "aliquip Excepteur",
"ref": "elit enim sit ad"
}
],
"_id": "7d02BBbF011f17d0e97eEC7A",
"description": "et cupidatat laborum aliqua do",
"gbacWrite": [
"sit reprehenderit irure sint adipisicing",
"esse consequat",
"sit culpa exercitation et aute"
],
"version": 1
},
"edit": "aute ullamco"
}
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"
]
}