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": [
"laborum amet irure eiusmod",
"qui anim ut in",
"amet sunt proident aliqua dolore",
"occaecat",
"voluptate est dolore"
],
"members": [],
"_id": "Dd2c6f2fc7CEF8132b1FC7c4",
"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": [
"dolore eu proident"
],
"members": [],
"_id": "aacCaAAb182bD6f20ab6Aa8a",
"description": "labore ex ad in pariatur",
"gbacWrite": [
"deserunt",
"adipisicing sit ut",
"irure sed est dolor",
"minim"
],
"version": 1
},
"edit": "laborum magna 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"
]
}