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": [
"ea voluptate dolor adipisicing officia",
"sunt cupidatat",
"enim proident Ut",
"adipisicing elit est sit",
"occaecat ut sunt adipisicing ex"
],
"members": [
{
"path": [
"fugiat tempor culpa"
],
"type": "folder"
}
],
"_id": "fAaBa0E55c1CBb247EfDCAe6",
"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": [
"Duis anim ad"
],
"members": [
{
"path": [
"enim velit laboris Lorem id"
],
"type": "folder"
},
{
"path": [
"qui pariatur anim dolore mollit",
"consequat nulla",
"esse in ut"
],
"type": "folder"
},
{
"path": [
"cupidatat culpa sint"
],
"type": "folder"
},
{
"path": [
"officia non elit",
"aliqua in aute",
"fugiat Duis reprehenderit sit"
],
"type": "folder"
},
{
"path": "consectetur cupidatat enim adipisicing",
"type": "component",
"sourceCollection": "aliqua laboris minim sunt",
"ref": "exercitation non laborum adipisicing"
}
],
"_id": "4F8a6d321d302287ae7892bc",
"description": "velit Ut magna veniam eiusmod",
"gbacWrite": [
"eiusmod elit incididunt Excepteur",
"aliqua"
],
"version": 1
},
"edit": "enim deserunt anim aliqua sint"
}
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"
]
}