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": [
"culpa do exercitation cillum nulla",
"laboris",
"dolore voluptate",
"eiusmod sit dolore Ut"
],
"members": [
{
"path": [
"et incididunt cillum sint",
"aute fugiat officia Duis",
"voluptate Ut nisi exercitation",
"enim labore sunt Excepteur Duis"
],
"type": "folder"
}
],
"_id": "df2cfCD5FB60401Bac2eD18f",
"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": [
"aliqua ullamco cillum",
"quis reprehenderit et laborum laboris",
"laboris ea",
"enim cillum reprehenderit velit"
],
"members": [
{
"path": "in velit",
"type": "component",
"sourceCollection": "mollit quis velit est",
"ref": "sint non velit in"
},
{
"path": [
"commodo"
],
"type": "folder"
},
{
"path": [
"nostrud culpa consectetur cillum"
],
"type": "folder"
}
],
"_id": "94AE56BC00903894d652Dc10",
"description": "Lorem ea dolore pariatur",
"gbacWrite": [
"incididunt dolore",
"elit dolore ad"
],
"version": 1
},
"edit": "culpa sit ipsum"
}
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"
]
}