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": [
"velit",
"elit ex nulla",
"quis irure occaecat cillum Duis"
],
"members": [
{
"path": [
"pariatur reprehenderit aliquip dolor",
"incididunt occaecat fugiat",
"aliqua aliquip commodo eiusmod"
],
"type": "folder"
},
{
"path": "proident ut Duis fugiat",
"type": "component",
"sourceCollection": "mollit labore proident Ut elit",
"ref": "eiusmod"
},
{
"path": "fugiat esse reprehenderit ex in",
"type": "component",
"sourceCollection": "cillum in ut consequat",
"ref": "velit"
},
{
"path": [
"nisi enim non in",
"ex irure",
"exercitation consequat enim commodo dolore",
"nostrud ea"
],
"type": "folder"
},
{
"path": [
"cupidatat sit incididunt",
"eu sed mollit",
"eiusmod sunt mollit",
"in elit minim"
],
"type": "folder"
}
],
"_id": "f8bd669CD3C1c55DcCcCAc14",
"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": [
"ex in aute proident est",
"labore"
],
"members": [
{
"path": "ut Excepteur ea",
"type": "component",
"sourceCollection": "aliquip",
"ref": "quis dolore Duis aliqua esse"
},
{
"path": "incididunt dolor mollit",
"type": "component",
"sourceCollection": "consectetur officia",
"ref": "commodo anim dolor ut do"
},
{
"path": "veniam eu",
"type": "component",
"sourceCollection": "mollit",
"ref": "deserunt culpa in sit"
},
{
"path": "fugiat amet enim",
"type": "component",
"sourceCollection": "ipsum ut",
"ref": "dolor adipisicing occaecat laborum fugiat"
},
{
"path": [
"dolore dolor",
"velit Excepteur consectetur",
"consequat Excepteur elit",
"ad proident commodo",
"labore irure"
],
"type": "folder"
}
],
"_id": "b18C66E64e54BAD11eaBfbFe",
"description": "dolor mollit veniam non ut",
"gbacWrite": [
"pariatur ut sint aliquip",
"dolore Excepteur nulla dolor do"
],
"version": 1
},
"edit": "ipsum nulla culpa velit Lorem"
}
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"
]
}
