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": [
"dolore mollit",
"irure est amet",
"Excepteur amet sint minim",
"non aute",
"fugiat aliquip"
],
"members": [
{
"path": "eu",
"type": "component",
"sourceCollection": "commodo ut",
"ref": "irure"
}
],
"_id": "Bd8317b9ceFCb8b87cDe36Bf",
"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": [
"cupidatat pariatur minim",
"ut mollit eu Ut",
"velit",
"commodo",
"laboris sunt Lorem"
],
"members": [
{
"path": "id",
"type": "component",
"sourceCollection": "Lorem enim voluptate ipsum",
"ref": "exercitation sint"
}
],
"_id": "BD0e8eb952975a20F5fEb139",
"description": "voluptate Ut in ea do",
"gbacWrite": [
"fugiat culpa esse ut",
"eu nisi amet Ut",
"est occaecat officia eiusmod elit"
],
"version": 1
},
"edit": "quis consequat adipisicing nostrud"
}
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"
]
}