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": [
"enim reprehenderit sit exercitation aliqua",
"officia deserunt",
"mollit ex",
"voluptate Duis officia"
],
"members": [
{
"path": "aliqua non commodo",
"type": "component",
"sourceCollection": "sint aute occaecat cupidatat",
"ref": "enim aute"
},
{
"path": [
"sit magna",
"in",
"nulla ut culpa elit"
],
"type": "folder"
},
{
"path": "velit magna",
"type": "component",
"sourceCollection": "officia cupidatat",
"ref": "aliquip sint exercitation"
},
{
"path": "ad pariatur",
"type": "component",
"sourceCollection": "non",
"ref": "ad Ut tempor"
},
{
"path": "elit eu irure fugiat dolore",
"type": "component",
"sourceCollection": "veniam",
"ref": "dolore"
}
],
"_id": "A571be2eE6976c8E05fA0DF6",
"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": [
"sunt",
"ipsum Excepteur ad ut eu"
],
"members": [
{
"path": "Ut",
"type": "component",
"sourceCollection": "Excepteur qui",
"ref": "incididunt ipsum aliquip eiusmod dolor"
},
{
"path": [
"in dolore",
"eu",
"pariatur cupidatat minim",
"enim"
],
"type": "folder"
},
{
"path": "velit mollit do",
"type": "component",
"sourceCollection": "sunt laborum est",
"ref": "velit dolor"
}
],
"_id": "6478ab8EE458EBD9bc977DF6",
"description": "sit consectetur",
"gbacWrite": [
"Ut esse"
],
"version": 1
},
"edit": "sunt sit eu"
}
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"
]
}
