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": [
"do amet",
"dolor",
"ex eu consequat",
"ipsum laboris velit"
],
"members": [
{
"path": [
"cillum labore veniam ex",
"veniam Duis aliquip",
"laboris id in velit Lorem",
"commodo non"
],
"type": "folder"
}
],
"_id": "6C8aCA259B76b3e25DFBA1cf",
"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": [
"sunt enim eu ipsum in",
"irure in quis sit tempor",
"occaecat non sit Duis",
"sint"
],
"members": [
{
"path": "pariatur ut",
"type": "component",
"sourceCollection": "ut in do",
"ref": "aute do"
},
{
"path": [
"fugiat aliquip",
"laboris minim",
"sit velit",
"est reprehenderit in occaecat"
],
"type": "folder"
}
],
"_id": "4AddCadF9F57aDF7E11C556b",
"description": "consequat eiusmod nulla Excepteur",
"gbacWrite": [
"dolor elit laboris id",
"reprehenderit labore enim anim",
"mollit pariatur dolore incididunt non"
],
"version": 1
},
"edit": "officia dolor"
}
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"
]
}