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": [
"nulla",
"adipisicing"
],
"members": [
{
"path": [
"culpa esse",
"adipisicing",
"sit",
"ullamco non",
"Excepteur Ut consequat eiusmod"
],
"type": "folder"
}
],
"_id": "f60af08e8a5eFB17DBEF42C4",
"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": [
"aliquip amet dolor dolore",
"est do dolore sint Ut",
"exercitation id in eiusmod in"
],
"members": [
{
"path": [
"minim sit adipisicing sint",
"reprehenderit",
"ut commodo",
"deserunt non nostrud do",
"aute Excepteur"
],
"type": "folder"
},
{
"path": "culpa velit adipisicing ex dolor",
"type": "component",
"sourceCollection": "quis elit eu non",
"ref": "officia"
}
],
"_id": "bAceeE307aDab39dBBEFCdb8",
"description": "incididunt do Ut veniam sunt",
"gbacWrite": [
"laboris",
"cupidatat labore magna aliqua ut",
"eu pariatur esse anim et"
],
"version": 1
},
"edit": "occaecat"
}
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"
]
}