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 nisi veniam amet"
],
"members": [
{
"path": [
"qui deserunt et dolore officia",
"ut cupidatat Excepteur",
"culpa nisi"
],
"type": "folder"
},
{
"path": "elit magna minim labore",
"type": "component",
"sourceCollection": "eu Ut exercitation do",
"ref": "exercitation Ut Duis"
}
],
"_id": "D07bfC070bDCF6e708aaa6bf",
"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": [
"eu irure dolor Lorem est",
"mollit do non consectetur",
"Lorem ad Duis ipsum enim",
"Duis"
],
"members": [
{
"path": "adipisicing tempor magna",
"type": "component",
"sourceCollection": "sint",
"ref": "nulla sit dolore ullamco"
},
{
"path": [
"enim Duis dolor nisi",
"exercitation nostrud ad"
],
"type": "folder"
}
],
"_id": "9C19ef1fa7E5e1c74deeb8c0",
"description": "dolore ullamco ut",
"gbacWrite": [
"Excepteur enim occaecat non sunt",
"ex eiusmod",
"eu anim elit nisi"
],
"version": 1
},
"edit": "ipsum in"
}
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"
]
}