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": [
"dolor deserunt officia tempor ad",
"voluptate ipsum aliquip",
"sed aliqua quis reprehenderit culpa"
],
"members": [
{
"path": [
"Lorem cupidatat velit irure",
"eiusmod dolore anim"
],
"type": "folder"
},
{
"path": "dolor",
"type": "component",
"sourceCollection": "ut consectetur irure",
"ref": "in enim ad non"
},
{
"path": [
"mollit sed Lorem sit labore",
"tempor Lorem commodo",
"Ut ipsum voluptate esse eu"
],
"type": "folder"
},
{
"path": "consectetur",
"type": "component",
"sourceCollection": "Excepteur eu in sed tempor",
"ref": "ea ad aliqua laborum nisi"
}
],
"_id": "fbB68358AFAdE9E6B4Ca303e",
"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": [
"magna",
"aute cupidatat ut ea deserunt"
],
"members": [
{
"path": "magna ullamco ad",
"type": "component",
"sourceCollection": "sit",
"ref": "reprehenderit"
},
{
"path": "minim",
"type": "component",
"sourceCollection": "exercitation ullamco",
"ref": "dolor cillum ut"
},
{
"path": "sit deserunt",
"type": "component",
"sourceCollection": "sunt magna ea Ut laboris",
"ref": "enim exercitation consequat mollit"
}
],
"_id": "c41e456f7A6A599bb3e1cAAB",
"description": "laborum ullamco cupidatat nulla quis",
"gbacWrite": [
"ullamco mollit eu",
"adipisicing",
"occaecat do"
],
"version": 1
},
"edit": "anim"
}
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"
]
}
