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": [
"nostrud qui dolore"
],
"members": [
{
"path": [
"dolor",
"commodo eu occaecat",
"eiusmod laboris id qui pariatur"
],
"type": "folder"
},
{
"path": [
"dolor Ut in aliqua exercitation",
"exercitation magna irure ut",
"Duis aliquip id ipsum esse"
],
"type": "folder"
},
{
"path": "fugiat cillum exercitation",
"type": "component",
"sourceCollection": "id nulla consequat adipisicing in",
"ref": "nisi ea anim cillum"
},
{
"path": "eiusmod ea fugiat laborum",
"type": "component",
"sourceCollection": "consectetur Lorem commodo enim",
"ref": "sunt Lorem deserunt laboris commodo"
}
],
"_id": "d29d9f6dA6DbBb5FD043Cb5A",
"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": [
"cupidatat exercitation nostrud culpa",
"dolor",
"occaecat fugiat",
"amet ut"
],
"members": [
{
"path": [
"magna enim reprehenderit consectetur",
"voluptate commodo eiusmod",
"in",
"quis velit consectetur in",
"enim irure Duis commodo"
],
"type": "folder"
},
{
"path": [
"pariatur veniam"
],
"type": "folder"
}
],
"_id": "e287e786c979B92CCFd92F31",
"description": "ex deserunt amet sint",
"gbacWrite": [
"irure",
"ex mollit magna incididunt",
"pariatur Ut proident velit qui",
"Duis eiusmod",
"qui"
],
"version": 1
},
"edit": "incididunt fugiat aliquip et dolore"
}
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"
]
}