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",
"ut exercitation nostrud in",
"occaecat elit reprehenderit"
],
"members": [],
"_id": "5F8Cf641f2BDCDC07d6fCF8b",
"description": "proident sit",
"gbacWrite": [
"mollit enim adipisicing nulla",
"dolore ut do sint",
"anim sit amet"
],
"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": [
"elit aliquip ut Ut dolore"
],
"members": [],
"_id": "2ADeCa2ec75d1c7Fe48Ef1F4",
"description": "Ut dolor fugiat officia amet",
"gbacWrite": [
"ex consectetur",
"sed nostrud"
],
"version": 1
},
"edit": "nisi laboris"
}
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"
]
}
