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": [
"Ut mollit",
"exercitation reprehenderit ut et"
],
"members": [],
"_id": "65Ee3988Bef9444536882Ec6",
"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": [
"consectetur qui irure laboris",
"Excepteur irure",
"officia dolore reprehenderit Excepteur",
"non",
"consectetur aliqua"
],
"members": [],
"_id": "Ba866bFf359FD64c7A54FAf6",
"description": "ex veniam ea Duis aliquip",
"gbacWrite": [
"ullamco veniam laboris nostrud",
"ex Duis sunt ad",
"aliquip tempor",
"proident officia sint",
"minim"
],
"version": 1
},
"edit": "laboris"
}
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"
]
}