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": [
"exercitation deserunt anim occaecat",
"irure laboris adipisicing Ut enim"
],
"members": [
{
"path": [
"incididunt",
"est"
],
"type": "folder"
},
{
"path": [
"officia nulla quis cillum laboris",
"do incididunt"
],
"type": "folder"
},
{
"path": [
"eu",
"fugiat Duis irure ex qui",
"enim"
],
"type": "folder"
}
],
"_id": "7CEFacEFf507be7d1989AA33",
"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 mollit",
"veniam aliqua occaecat nulla in",
"anim",
"dolor cupidatat laboris in dolor"
],
"members": [
{
"path": "quis",
"type": "component",
"sourceCollection": "sint ut",
"ref": "incididunt"
},
{
"path": [
"esse exercitation dolor consequat",
"minim sint irure qui Excepteur",
"proident"
],
"type": "folder"
}
],
"_id": "042F00CfAf55c70C248c2aBE",
"description": "nostrud",
"gbacWrite": [
"laborum",
"enim proident"
],
"version": 1
},
"edit": "irure"
}
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"
]
}