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": [
"nulla id ex"
],
"members": [
{
"path": [
"velit in laboris",
"est sed aliqua",
"cupidatat dolore tempor"
],
"type": "folder"
},
{
"path": "eiusmod veniam dolore",
"type": "component",
"sourceCollection": "sunt dolor et",
"ref": "id dolor aliqua Ut"
},
{
"path": "nisi reprehenderit",
"type": "component",
"sourceCollection": "occaecat laborum",
"ref": "incididunt esse"
},
{
"path": "cillum nisi",
"type": "component",
"sourceCollection": "quis sunt consectetur laboris magna",
"ref": "mollit sunt anim sit"
}
],
"_id": "EfA022AF6bFa2EbADa3AEFfe",
"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": [
"dolor pariatur aliqua",
"laborum"
],
"members": [
{
"path": "qui esse",
"type": "component",
"sourceCollection": "Duis consectetur ipsum ut qui",
"ref": "ad dolore culpa"
},
{
"path": [
"elit enim qui do",
"anim",
"dolor aliqua ut velit pariatur",
"aliqua deserunt",
"incididunt do ipsum reprehenderit"
],
"type": "folder"
}
],
"_id": "aCecFBf31f2fB2A9bC17A030",
"description": "laborum",
"gbacWrite": [
"magna anim",
"irure",
"Ut et",
"Lorem ut adipisicing culpa"
],
"version": 1
},
"edit": "in aute elit"
}
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"
]
}