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": [
"officia",
"sit non",
"velit",
"Excepteur incididunt nulla",
"consectetur cupidatat deserunt et"
],
"members": [
{
"path": "ut",
"type": "component",
"sourceCollection": "Lorem dolore mollit",
"ref": "ea et exercitation"
},
{
"path": "velit eu reprehenderit amet ad",
"type": "component",
"sourceCollection": "esse eu sit mollit et",
"ref": "in anim esse laboris"
},
{
"path": [
"fugiat magna velit ex exercitation",
"do",
"enim mollit"
],
"type": "folder"
}
],
"_id": "83B0DBf7CaFb95FBbeE8F3B0",
"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": [
"cillum",
"culpa fugiat in",
"exercitation ex",
"laboris"
],
"members": [
{
"path": [
"nostrud Excepteur",
"in laborum cupidatat id",
"tempor aute proident"
],
"type": "folder"
},
{
"path": "occaecat ut nisi minim laborum",
"type": "component",
"sourceCollection": "ullamco aute",
"ref": "deserunt cupidatat occaecat do"
},
{
"path": [
"ullamco in ad incididunt",
"enim officia pariatur commodo",
"pariatur consequat nisi",
"eiusmod non in mollit exercitation"
],
"type": "folder"
},
{
"path": [
"in",
"adipisicing proident irure",
"labore fugiat",
"ex non"
],
"type": "folder"
},
{
"path": "tempor commodo veniam",
"type": "component",
"sourceCollection": "quis in",
"ref": "labore elit ex Excepteur ut"
}
],
"_id": "ff82F914eED8D9D89C92E5fA",
"description": "reprehenderit dolore",
"gbacWrite": [
"proident Excepteur dolor anim",
"culpa Excepteur aute",
"fugiat ipsum",
"sunt culpa",
"id adipisicing Duis"
],
"version": 1
},
"edit": "magna labore id aute"
}
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"
]
}
