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": [
"enim nulla elit culpa reprehenderit"
],
"members": [
{
"path": "deserunt Ut sint qui",
"type": "component",
"sourceCollection": "enim Excepteur officia dolor",
"ref": "nulla aute est dolor ad"
},
{
"path": [
"pariatur",
"proident",
"ex",
"deserunt Duis",
"sint cillum nostrud"
],
"type": "folder"
}
],
"_id": "38DC65a105b895a6c108C2D7",
"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": [
"quis aliquip"
],
"members": [
{
"path": [
"laboris irure",
"ea minim dolore elit",
"sunt enim aliquip eu cillum"
],
"type": "folder"
},
{
"path": [
"Lorem eiusmod enim reprehenderit velit",
"id eu ex"
],
"type": "folder"
},
{
"path": [
"Excepteur irure",
"adipisicing do incididunt sunt id",
"Ut"
],
"type": "folder"
},
{
"path": "in",
"type": "component",
"sourceCollection": "amet reprehenderit Ut est",
"ref": "id aliquip minim adipisicing voluptate"
},
{
"path": [
"enim",
"reprehenderit",
"Excepteur in",
"velit amet"
],
"type": "folder"
}
],
"_id": "eD96AFb10163a58eFAe08eCC",
"description": "velit et laborum aliqua",
"gbacWrite": [
"quis",
"sunt sint incididunt eiusmod in",
"irure ad"
],
"version": 1
},
"edit": "velit consequat ut 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"
]
}