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": [
"consequat nostrud voluptate ut",
"eiusmod id"
],
"members": [
{
"path": [
"deserunt irure",
"enim deserunt aliqua sed minim",
"ea"
],
"type": "folder"
},
{
"path": "dolore fugiat Lorem",
"type": "component",
"sourceCollection": "fugiat adipisicing",
"ref": "nisi"
},
{
"path": "sit esse pariatur",
"type": "component",
"sourceCollection": "et sit mollit eiusmod nisi",
"ref": "minim"
},
{
"path": "aute deserunt",
"type": "component",
"sourceCollection": "enim in Lorem",
"ref": "ut in pariatur consectetur dolore"
}
],
"_id": "6CFb62C0ECbacC7CbeeDFaAC",
"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": [
"proident",
"esse proident nostrud ad",
"id",
"adipisicing eu velit",
"commodo eu ullamco"
],
"members": [
{
"path": "Ut laborum consectetur",
"type": "component",
"sourceCollection": "cupidatat ea",
"ref": "pariatur qui velit Ut laboris"
},
{
"path": [
"occaecat cillum",
"fugiat",
"do"
],
"type": "folder"
},
{
"path": "officia est laboris dolor",
"type": "component",
"sourceCollection": "cupidatat ullamco eu",
"ref": "labore non nisi"
}
],
"_id": "0cAdEeadA43DC4c41B4626EC",
"description": "in Excepteur irure Ut",
"gbacWrite": [
"enim",
"veniam ut laboris",
"incididunt dolor",
"sint incididunt reprehenderit adipisicing pariatur",
"aliqua"
],
"version": 1
},
"edit": "do nostrud ut consectetur cillum"
}
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"
]
}
