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 Lorem dolore deserunt"
],
"members": [
{
"path": [
"est esse Duis quis magna",
"laboris exercitation",
"aliqua sed non nulla laborum",
"nostrud magna et"
],
"type": "folder"
},
{
"path": "ullamco dolor est pariatur Lorem",
"type": "component",
"sourceCollection": "consectetur est qui velit commodo",
"ref": "laborum labore laboris Ut"
}
],
"_id": "6CE3F1Cf354fdCbf5e43492B",
"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": [
"deserunt labore nostrud elit consectetur",
"aute nostrud elit do dolor",
"cupidatat Ut minim aliquip"
],
"members": [
{
"path": [
"in sed",
"eiusmod nisi consequat ipsum",
"sed do qui ut",
"incididunt amet in",
"veniam ea Excepteur"
],
"type": "folder"
},
{
"path": "consectetur adipisicing ipsum elit qui",
"type": "component",
"sourceCollection": "Lorem aliquip",
"ref": "occaecat non veniam est in"
}
],
"_id": "e379b618b0a4a721EF25a8F9",
"description": "do cillum dolore consequat",
"gbacWrite": [
"ipsum do cupidatat in",
"qui consequat",
"adipisicing laboris ipsum occaecat"
],
"version": 1
},
"edit": "ipsum Ut"
}
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"
]
}