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": [
"qui in Ut",
"dolore",
"ad consectetur mollit",
"labore adipisicing cupidatat dolore consectetur",
"ipsum nostrud"
],
"members": [
{
"path": "nisi aute nostrud",
"type": "component",
"sourceCollection": "Duis nulla dolor adipisicing",
"ref": "laboris Excepteur eiusmod non est"
}
],
"_id": "f1bce2FeC0A6734BEADCd8BF",
"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": [
"culpa elit veniam esse aliquip",
"pariatur",
"est",
"voluptate nisi magna quis fugiat",
"irure"
],
"members": [
{
"path": [
"nostrud"
],
"type": "folder"
}
],
"_id": "FdeDB8b5F022dcDddccaFd4F",
"description": "nostrud Excepteur ad",
"gbacWrite": [
"cillum mollit esse",
"velit",
"dolore aliqua eu",
"incididunt",
"aliquip"
],
"version": 1
},
"edit": "ea officia occaecat"
}
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"
]
}
