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": [
"Excepteur deserunt Duis reprehenderit",
"velit do",
"aliquip pariatur ut cupidatat",
"ullamco veniam id",
"dolor"
],
"members": [
{
"path": "Excepteur aliqua nulla",
"type": "component",
"sourceCollection": "ipsum",
"ref": "ut et ad dolore"
},
{
"path": [
"voluptate nostrud reprehenderit"
],
"type": "folder"
},
{
"path": [
"nostrud exercitation",
"Excepteur sed dolore in",
"laboris in ut Duis nisi",
"do mollit ullamco deserunt",
"officia qui adipisicing"
],
"type": "folder"
},
{
"path": "velit magna sed",
"type": "component",
"sourceCollection": "sit eu occaecat fugiat est",
"ref": "qui consectetur"
},
{
"path": [
"ipsum ut ut adipisicing",
"in eu ad veniam adipisicing",
"Ut nulla",
"dolore nisi",
"Excepteur do"
],
"type": "folder"
}
],
"_id": "dB52310eF50DAaB41d8fD4aA",
"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",
"nostrud cillum",
"et ea aliqua",
"consectetur aliquip"
],
"members": [
{
"path": [
"est laborum anim",
"incididunt"
],
"type": "folder"
},
{
"path": [
"reprehenderit"
],
"type": "folder"
},
{
"path": [
"tempor nostrud",
"officia eiusmod qui fugiat",
"aliqua dolor est"
],
"type": "folder"
}
],
"_id": "ad9dAb159E839aACaed700dE",
"description": "ut Duis commodo qui",
"gbacWrite": [
"est"
],
"version": 1
},
"edit": "aliqua"
}
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"
]
}
