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": [
"non dolor exercitation sit"
],
"members": [
{
"path": [
"enim eu culpa",
"officia labore veniam cillum",
"fugiat ut",
"ut aliqua commodo culpa",
"dolor commodo quis aliqua"
],
"type": "folder"
},
{
"path": "tempor ullamco",
"type": "component",
"sourceCollection": "ut",
"ref": "cillum eu nisi"
},
{
"path": "pariatur eiusmod eu ex enim",
"type": "component",
"sourceCollection": "adipisicing aute",
"ref": "sint exercitation laboris amet"
},
{
"path": "nostrud eu",
"type": "component",
"sourceCollection": "dolore dolore qui",
"ref": "Duis commodo ut"
},
{
"path": [
"anim",
"sed",
"aliquip non irure ea occaecat"
],
"type": "folder"
}
],
"_id": "160E8eEb5f4b02a8bDC4B7F0",
"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": [
"nostrud anim"
],
"members": [
{
"path": "dolor amet",
"type": "component",
"sourceCollection": "deserunt",
"ref": "in"
}
],
"_id": "754D884FFE0ff6f93fbd643B",
"description": "exercitation in labore",
"gbacWrite": [
"sint officia aliqua incididunt fugiat",
"veniam qui ex dolor",
"Duis anim exercitation elit fugiat"
],
"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"
]
}