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": [
"consectetur occaecat esse anim in",
"occaecat amet sit",
"Duis sunt dolor"
],
"members": [
{
"path": "fugiat nostrud sunt magna",
"type": "component",
"sourceCollection": "dolor quis aliqua incididunt",
"ref": "ullamco non veniam"
},
{
"path": "commodo id Excepteur sint",
"type": "component",
"sourceCollection": "esse in enim sint ea",
"ref": "elit culpa labore eiusmod officia"
}
],
"_id": "De3baA6a35c09eacbB31fCDe",
"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": [
"Ut amet Duis Lorem enim",
"anim eu est ipsum Duis",
"dolore incididunt do quis eiusmod",
"eu sed anim",
"fugiat cillum dolor ipsum non"
],
"members": [
{
"path": "aliqua labore culpa in Excepteur",
"type": "component",
"sourceCollection": "voluptate dolore minim",
"ref": "laboris Duis qui nisi pariatur"
},
{
"path": "eiusmod officia velit deserunt aliqua",
"type": "component",
"sourceCollection": "dolore",
"ref": "qui magna pariatur"
}
],
"_id": "6bA3fC5b6fA80dEcDF64C4be",
"description": "incididunt",
"gbacWrite": [
"cillum Duis tempor laboris"
],
"version": 1
},
"edit": "sunt nostrud"
}
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"
]
}