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": [
"amet fugiat anim",
"deserunt reprehenderit quis sed",
"minim ut non ex ut",
"adipisicing aliqua ut",
"aute incididunt do velit"
],
"members": [
{
"path": "dolore occaecat exercitation ea",
"type": "component",
"sourceCollection": "ut occaecat anim ex",
"ref": "ea"
},
{
"path": "minim ullamco in nostrud exercitation",
"type": "component",
"sourceCollection": "magna Duis",
"ref": "magna"
},
{
"path": "in do minim",
"type": "component",
"sourceCollection": "Ut",
"ref": "nostrud Lorem in"
},
{
"path": "fugiat ut elit Excepteur",
"type": "component",
"sourceCollection": "irure non laboris deserunt",
"ref": "nostrud consequat"
}
],
"_id": "B4Bb0AD0D1daD145e0cAd87f",
"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": [
"ullamco",
"pariatur eiusmod voluptate do minim",
"et",
"commodo",
"labore"
],
"members": [
{
"path": [
"labore reprehenderit",
"qui Duis"
],
"type": "folder"
},
{
"path": [
"occaecat",
"mollit ut dolore",
"id quis culpa",
"amet dolor magna"
],
"type": "folder"
}
],
"_id": "ae676a0abF6d8eFfFb79aa09",
"description": "ut ea ullamco culpa",
"gbacWrite": [
"ex culpa nostrud",
"cupidatat pariatur laboris"
],
"version": 1
},
"edit": "sunt cupidatat elit Excepteur"
}
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"
]
}
