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": [
"commodo enim laboris esse dolor",
"incididunt anim commodo",
"ea magna consectetur cillum in",
"ipsum",
"sit"
],
"members": [],
"_id": "03864B82091112d0dde0eFae",
"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": [
"non nostrud",
"incididunt est nostrud sit",
"laborum id sed eiusmod nulla"
],
"members": [],
"_id": "BF3B7D1aAFCd0eDE4AD86ceB",
"description": "minim in",
"gbacWrite": [
"Duis adipisicing Lorem voluptate",
"dolore",
"ullamco proident"
],
"version": 1
},
"edit": "magna et proident Ut"
}
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"
]
}