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": [
"Lorem",
"dolore cillum anim fugiat pariatur",
"exercitation veniam",
"aliquip deserunt voluptate consectetur"
],
"members": [
{
"path": "ut tempor",
"type": "component",
"sourceCollection": "commodo aliqua id ullamco",
"ref": "nisi id quis in"
}
],
"_id": "dB3Ce0E57E6C4c8EEFaA0A9b",
"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": [
"elit sit",
"labore",
"nulla fugiat deserunt",
"ad Ut enim in"
],
"members": [
{
"path": "Excepteur nisi voluptate",
"type": "component",
"sourceCollection": "ea Lorem",
"ref": "ut aute pariatur consequat"
},
{
"path": [
"sunt",
"ullamco Lorem"
],
"type": "folder"
},
{
"path": "ullamco",
"type": "component",
"sourceCollection": "elit incididunt",
"ref": "ut voluptate cillum ex"
},
{
"path": [
"Excepteur qui",
"cillum",
"aliqua",
"Lorem"
],
"type": "folder"
}
],
"_id": "1EC4dB1F449Cb3dDfEe6DbDb",
"description": "consectetur proident",
"gbacWrite": [
"ut"
],
"version": 1
},
"edit": "reprehenderit ullamco consequat incididunt"
}
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"
]
}