Summary
Creates a new component group document.
Description
Creates a new component group document.
Route
POST /automation-studio/component-groups
Roles
admin
apiwrite
designer
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| componentGroup |
object |
yes |
Component group entity to create. |
Copied to Clipboard
{
"componentGroup": {
"name": "test",
"gbacRead": [
"officia et Ut",
"magna proident consectetur Ut ad"
],
"members": [],
"_id": "0Ff3268786D7bAF2B9a4CC6f",
"description": "mollit",
"gbacWrite": [
"officia",
"anim quis et do eiusmod",
"dolor minim sunt",
"eiusmod"
],
"version": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"componentGroup": {
"title": "componentGroup",
"$ref": "componentGroup"
}
},
"required": [
"componentGroup"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Created component group and associated edit URI. |
Copied to Clipboard
{
"created": {
"name": "test",
"gbacRead": [
"enim",
"in do aliqua aute irure",
"ex Excepteur ad",
"reprehenderit"
],
"members": [],
"_id": "ADf412Bb4eBbb0BdE93Af23f",
"description": "dolor",
"gbacWrite": [
"ea non aute aliqua esse",
"Lorem enim",
"occaecat",
"aliquip sed"
],
"version": 1
},
"edit": "cillum"
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"description": "Created component group and associated edit URI.",
"properties": {
"created": {
"$ref": "componentGroup"
},
"edit": {
"type": "string",
"description": "URI to the edit page for the newly created component group."
}
},
"required": [
"created",
"edit"
]
}
