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": [
"incididunt enim",
"Duis culpa"
],
"members": [],
"_id": "db4377Ba3F0D03D859e160fE",
"description": "Duis",
"gbacWrite": [
"deserunt ut nostrud",
"ea ut",
"ullamco eu est nostrud",
"sit dolor voluptate exercitation",
"ut officia"
],
"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": [
"sit eu dolore",
"adipisicing amet",
"cillum",
"deserunt esse dolor"
],
"members": [],
"_id": "eAAF4c725Ca0eaC62a750E4e",
"description": "voluptate pariatur in",
"gbacWrite": [
"nulla",
"Excepteur minim occaecat magna",
"nostrud dolore",
"ullamco",
"Ut"
],
"version": 1
},
"edit": "tempor cupidatat dolore"
}
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"
]
}
