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": [
"adipisicing et ullamco ea nisi",
"officia"
],
"members": [
{
"path": "irure eiusmod enim fugiat in",
"type": "component",
"sourceCollection": "cillum ex",
"ref": "nulla ex"
}
],
"_id": "de5e3E45Cf09a6dCc712F0C3",
"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": [
"dolore dolor occaecat"
],
"members": [
{
"path": "sed velit tempor",
"type": "component",
"sourceCollection": "ipsum voluptate incididunt consectetur",
"ref": "nulla"
},
{
"path": [
"est veniam velit culpa id"
],
"type": "folder"
}
],
"_id": "7Aa3EE286cF474ad0bfA2eF9",
"description": "esse sed",
"gbacWrite": [
"amet dolore laboris"
],
"version": 1
},
"edit": "magna sit sint"
}
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"
]
}
