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": [
"ipsum ea dolor",
"pariatur nisi",
"exercitation ullamco amet",
"cillum dolor dolor dolore"
],
"members": [
{
"path": [
"exercitation consequat aliquip",
"aliqua fugiat",
"nulla cillum"
],
"type": "folder"
}
],
"_id": "F33ba8563B0D6bD5C0BFC6dE",
"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": [
"et culpa laboris sint",
"nostrud irure esse",
"ad aliquip culpa occaecat enim",
"dolore"
],
"members": [
{
"path": [
"ex officia deserunt quis cillum",
"dolor est dolore eiusmod",
"voluptate ea ullamco amet in",
"quis deserunt sunt"
],
"type": "folder"
},
{
"path": "elit aute",
"type": "component",
"sourceCollection": "et ex irure qui",
"ref": "ex esse"
},
{
"path": "aliqua Excepteur enim",
"type": "component",
"sourceCollection": "incididunt cupidatat velit exercitation",
"ref": "cillum adipisicing amet velit"
},
{
"path": [
"velit commodo fugiat",
"laborum amet nostrud Excepteur",
"incididunt",
"eiusmod consequat reprehenderit culpa",
"proident ex"
],
"type": "folder"
}
],
"_id": "ac53d250AF5b94eE7d10AF4A",
"description": "nulla fugiat incididunt veniam",
"gbacWrite": [
"proident exercitation fugiat",
"dolor ut in adipisicing exercitation",
"adipisicing ut enim sed Lorem",
"Excepteur dolor"
],
"version": 1
},
"edit": "proident anim eu officia"
}
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"
]
}