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": [
"Lorem eiusmod est aliqua",
"velit"
],
"members": [
{
"path": [
"esse irure aliquip incididunt voluptate",
"aliquip",
"ipsum officia mollit",
"minim sunt in ut",
"minim dolor consequat ipsum Ut"
],
"type": "folder"
},
{
"path": "amet cillum",
"type": "component",
"sourceCollection": "aute aliqua laboris magna exercitation",
"ref": "culpa aute"
},
{
"path": "laboris mollit esse aute dolor",
"type": "component",
"sourceCollection": "qui veniam dolor reprehenderit commodo",
"ref": "ex ipsum qui nisi"
},
{
"path": "laboris commodo",
"type": "component",
"sourceCollection": "aliqua cupidatat irure",
"ref": "minim ipsum occaecat dolor elit"
}
],
"_id": "Bdf9044371ef6970fE17Effd",
"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": [
"reprehenderit",
"occaecat incididunt minim deserunt enim"
],
"members": [
{
"path": "in exercitation Duis reprehenderit et",
"type": "component",
"sourceCollection": "officia ipsum velit in qui",
"ref": "ea irure ullamco culpa"
},
{
"path": [
"quis veniam",
"qui culpa et dolore eiusmod"
],
"type": "folder"
},
{
"path": [
"deserunt",
"deserunt aute"
],
"type": "folder"
}
],
"_id": "467E6BC9CC4C5a823B88A5F9",
"description": "sunt nisi est",
"gbacWrite": [
"nulla dolore",
"tempor consequat est Lorem ut",
"dolor",
"ea nisi laboris dolore mollit",
"deserunt dolor pariatur consectetur eu"
],
"version": 1
},
"edit": "sed pariatur eiusmod"
}
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"
]
}
