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": [
"est",
"ex dolore aliqua",
"nisi eu",
"fugiat ipsum qui Lorem"
],
"members": [
{
"path": "Duis elit irure",
"type": "component",
"sourceCollection": "laborum",
"ref": "labore"
},
{
"path": [
"sit dolore Excepteur",
"aliqua",
"aliqua esse aliquip magna"
],
"type": "folder"
},
{
"path": [
"aliquip nostrud ad",
"cillum"
],
"type": "folder"
},
{
"path": [
"id cillum esse"
],
"type": "folder"
}
],
"_id": "dF807d17aC825beCdEfc8e0C",
"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": [
"Duis ullamco ad"
],
"members": [
{
"path": "irure dolore in deserunt adipisicing",
"type": "component",
"sourceCollection": "quis ex velit consequat dolore",
"ref": "incididunt laborum Excepteur adipisicing ea"
},
{
"path": [
"laborum consectetur occaecat",
"irure in velit",
"eiusmod eu"
],
"type": "folder"
},
{
"path": [
"reprehenderit",
"culpa laboris deserunt dolore ex"
],
"type": "folder"
}
],
"_id": "beeA5FFf2461f7A32ef8A52b",
"description": "incididunt aliqua",
"gbacWrite": [
"proident",
"Lorem anim dolore",
"pariatur labore",
"do ut",
"anim est"
],
"version": 1
},
"edit": "laboris in"
}
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"
]
}