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": [
"sit dolore"
],
"members": [],
"_id": "469787FbdF1ca7247bfEbd22",
"description": "amet",
"gbacWrite": [
"occaecat in aliqua commodo ad",
"ex sint nisi qui cupidatat"
],
"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": [
"id eu labore sed fugiat",
"reprehenderit qui tempor cillum eiusmod",
"minim ad dolore",
"cupidatat exercitation Ut do Excepteur"
],
"members": [],
"_id": "ed01A9CDAfcB4e95CBbE2a8d",
"description": "in Duis",
"gbacWrite": [
"dolor esse reprehenderit nulla",
"elit fugiat laboris",
"et aute labore"
],
"version": 1
},
"edit": "officia fugiat ipsum"
}
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"
]
}
