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": [
"eu consequat",
"occaecat ullamco velit ut consectetur",
"dolor in culpa qui",
"labore exercitation ad",
"sit amet labore in"
],
"members": [
{
"path": [
"aliquip nostrud",
"officia",
"nulla ut Excepteur enim",
"tempor Excepteur eiusmod nisi",
"ea sed ipsum ut"
],
"type": "folder"
},
{
"path": [
"eiusmod",
"minim irure ut dolore",
"consectetur do"
],
"type": "folder"
},
{
"path": [
"ut laboris Lorem officia minim",
"eiusmod non",
"nostrud magna"
],
"type": "folder"
},
{
"path": "occaecat",
"type": "component",
"sourceCollection": "eu velit est",
"ref": "Lorem in"
},
{
"path": [
"reprehenderit consequat aliquip et amet"
],
"type": "folder"
}
],
"_id": "0A43D9cADBE6DF0eE729cAd8",
"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": [
"Duis",
"anim amet velit aliquip"
],
"members": [
{
"path": [
"anim magna exercitation ut mollit",
"non ut Lorem et ex",
"minim anim",
"nulla reprehenderit Excepteur",
"cupidatat ex deserunt dolore"
],
"type": "folder"
}
],
"_id": "3DFD0F0b59F83f6740DaD61C",
"description": "deserunt occaecat",
"gbacWrite": [
"proident id adipisicing ullamco",
"elit in",
"Lorem",
"voluptate eiusmod aliquip",
"culpa labore dolore"
],
"version": 1
},
"edit": "in nulla"
}
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"
]
}