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 commodo deserunt",
"adipisicing Lorem",
"est",
"irure cillum culpa",
"cupidatat ut"
],
"members": [
{
"path": [
"sed adipisicing fugiat anim pariatur",
"consectetur",
"ipsum nulla",
"dolor eu adipisicing do culpa",
"culpa"
],
"type": "folder"
},
{
"path": [
"deserunt elit quis esse eiusmod",
"deserunt",
"Duis officia aliqua",
"laborum aliquip cupidatat"
],
"type": "folder"
}
],
"_id": "7fDEC1bCdc7fa4A17CcccfF5",
"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 aute non reprehenderit eu",
"nostrud enim sed fugiat",
"exercitation adipisicing"
],
"members": [
{
"path": "ullamco id",
"type": "component",
"sourceCollection": "ex ea",
"ref": "consequat eu commodo"
},
{
"path": [
"qui nisi exercitation"
],
"type": "folder"
},
{
"path": "proident Duis nostrud",
"type": "component",
"sourceCollection": "ut proident dolor nisi ipsum",
"ref": "dolor Lorem laboris"
}
],
"_id": "48D8CB982236bcdCefD62aDD",
"description": "nulla anim ea laborum Ut",
"gbacWrite": [
"tempor laboris"
],
"version": 1
},
"edit": "Duis ullamco aute esse"
}
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"
]
}