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": [
"elit cillum",
"anim ullamco deserunt",
"officia laborum sint",
"Lorem consectetur ullamco tempor"
],
"members": [
{
"path": "officia elit amet in",
"type": "component",
"sourceCollection": "in Ut",
"ref": "proident fugiat Ut"
}
],
"_id": "a59Fa0f820fBd1ADf5a19bf7",
"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": [
"adipisicing Excepteur",
"Duis adipisicing enim",
"in voluptate incididunt",
"ut",
"dolor"
],
"members": [
{
"path": "minim est ex",
"type": "component",
"sourceCollection": "nulla nisi irure",
"ref": "in labore ut"
}
],
"_id": "B27B3146996CBeDB6B5A83c6",
"description": "exercitation dolor nisi consectetur",
"gbacWrite": [
"dolor non voluptate aliquip commodo"
],
"version": 1
},
"edit": "mollit"
}
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"
]
}