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": [
"esse dolore",
"irure sunt ipsum id Excepteur",
"aliquip consequat dolor pariatur id"
],
"members": [
{
"path": "ullamco ut qui adipisicing reprehenderit",
"type": "component",
"sourceCollection": "in magna non dolor voluptate",
"ref": "ut anim nostrud non commodo"
},
{
"path": [
"ut",
"cupidatat anim Excepteur",
"ea qui Ut sed",
"dolor culpa",
"aliqua sunt et"
],
"type": "folder"
}
],
"_id": "eDC5AB399DF265D39DBB0b6b",
"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": [
"deserunt anim pariatur nostrud veniam",
"nulla pariatur do aliquip ut"
],
"members": [
{
"path": "labore",
"type": "component",
"sourceCollection": "cillum laborum et reprehenderit",
"ref": "id"
},
{
"path": [
"voluptate",
"esse in veniam",
"voluptate",
"nisi officia consequat anim",
"eiusmod voluptate deserunt"
],
"type": "folder"
},
{
"path": "mollit ut occaecat",
"type": "component",
"sourceCollection": "dolor consectetur qui labore incididunt",
"ref": "nulla enim ipsum fugiat elit"
},
{
"path": "commodo est dolor in",
"type": "component",
"sourceCollection": "ut dolor",
"ref": "cupidatat"
},
{
"path": [
"dolore enim ut nulla",
"irure enim incididunt magna laborum",
"qui mollit cupidatat Excepteur eiusmod",
"dolore elit commodo deserunt qui"
],
"type": "folder"
}
],
"_id": "2D8cA8E0D6DFCFbB9aaFABBa",
"description": "qui",
"gbacWrite": [
"aliqua deserunt cupidatat irure consectetur",
"tempor ut aute",
"in deserunt sint"
],
"version": 1
},
"edit": "voluptate sed incididunt magna adipisicing"
}
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"
]
}