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": [
"culpa ea aliqua anim",
"enim ex nostrud cillum"
],
"members": [
{
"path": "tempor ipsum",
"type": "component",
"sourceCollection": "quis enim pariatur sint",
"ref": "nisi sit"
},
{
"path": [
"incididunt laborum",
"ea",
"nisi ea cupidatat",
"quis Lorem veniam",
"ea"
],
"type": "folder"
},
{
"path": "dolore",
"type": "component",
"sourceCollection": "aliqua veniam sint nisi",
"ref": "eu id ex quis amet"
},
{
"path": "sit in nostrud esse",
"type": "component",
"sourceCollection": "fugiat nulla qui dolore ad",
"ref": "amet ut aliquip"
},
{
"path": "cillum sunt Duis ullamco Ut",
"type": "component",
"sourceCollection": "ut",
"ref": "minim dolor aute deserunt"
}
],
"_id": "C96a29f51eb126ffBCe8d3eB",
"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": [
"amet in",
"occaecat Lorem qui aliquip consequat",
"non nostrud magna et consequat",
"elit dolore ex"
],
"members": [
{
"path": [
"in",
"fugiat",
"eu qui Ut tempor",
"enim non incididunt eu"
],
"type": "folder"
}
],
"_id": "c9CC0912e6Bf773BEcdcAFae",
"description": "veniam in ex",
"gbacWrite": [
"veniam velit",
"sint amet culpa",
"minim et velit est",
"aute dolore labore fugiat",
"sint"
],
"version": 1
},
"edit": "Excepteur ad laborum aliqua"
}
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"
]
}
