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": [
"occaecat et velit deserunt aliquip",
"dolor"
],
"members": [
{
"path": "laborum ex aliqua qui cupidatat",
"type": "component",
"sourceCollection": "aliquip",
"ref": "ut ea proident laboris"
},
{
"path": [
"in eu dolore magna officia",
"mollit laboris eiusmod",
"enim eiusmod et Duis",
"do qui incididunt",
"ex non commodo"
],
"type": "folder"
}
],
"_id": "106DbcfB402e6aa1bEc84f2E",
"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": [
"enim exercitation"
],
"members": [
{
"path": "sed culpa do",
"type": "component",
"sourceCollection": "cupidatat",
"ref": "consequat consectetur"
},
{
"path": [
"magna laboris labore",
"non ut ullamco nulla Ut"
],
"type": "folder"
}
],
"_id": "dbCb78Ae18DB37B15BAAA5a7",
"description": "Excepteur exercitation",
"gbacWrite": [
"Duis amet sint dolore non",
"cillum aliquip Lorem ea",
"in ullamco sit eiusmod commodo",
"qui enim",
"dolor"
],
"version": 1
},
"edit": "adipisicing ut est"
}
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"
]
}