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": [
"qui sed",
"deserunt sunt"
],
"members": [
{
"path": "ea",
"type": "component",
"sourceCollection": "in consequat",
"ref": "voluptate sunt"
}
],
"_id": "ebB0Af0c1069B92ea8d2cc06",
"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": [
"ut ipsum adipisicing culpa anim",
"Ut mollit id sunt sit",
"Duis sint ullamco officia eiusmod",
"sit pariatur incididunt",
"et"
],
"members": [
{
"path": "elit adipisicing ut deserunt culpa",
"type": "component",
"sourceCollection": "Ut nulla ea",
"ref": "cupidatat sit ipsum exercitation sunt"
},
{
"path": "officia sunt eu magna veniam",
"type": "component",
"sourceCollection": "eu ut dolor",
"ref": "eu nisi deserunt"
}
],
"_id": "ADA4A9FFA2d8a32723F50777",
"description": "dolore anim occaecat",
"gbacWrite": [
"eiusmod quis",
"consectetur",
"adipisicing fugiat anim mollit"
],
"version": 1
},
"edit": "culpa"
}
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"
]
}