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": [
"velit",
"irure",
"mollit consequat eiusmod laborum"
],
"members": [
{
"path": "quis magna consectetur mollit culpa",
"type": "component",
"sourceCollection": "nostrud ullamco esse commodo quis",
"ref": "nostrud commodo"
}
],
"_id": "6Ee2EaCBcEF4dFd481D1b5dA",
"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 eiusmod consectetur veniam",
"sed Excepteur enim in ut",
"deserunt pariatur veniam aliqua ipsum",
"veniam consequat",
"cillum Lorem dolor"
],
"members": [
{
"path": [
"ea dolor"
],
"type": "folder"
},
{
"path": [
"reprehenderit",
"minim nulla magna laborum"
],
"type": "folder"
},
{
"path": "sint",
"type": "component",
"sourceCollection": "qui consectetur",
"ref": "id eiusmod reprehenderit"
}
],
"_id": "F2a64f10Ed521DD40e6FbE62",
"description": "amet eu irure in aliqua",
"gbacWrite": [
"dolor ad in magna velit",
"commodo esse Ut",
"cupidatat voluptate",
"incididunt in",
"magna commodo ut"
],
"version": 1
},
"edit": "id pariatur Duis proident dolore"
}
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"
]
}