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",
"reprehenderit minim deserunt aliqua",
"reprehenderit fugiat dolore"
],
"members": [],
"_id": "7F1d017FF015Dbac8E7f31bd",
"description": "sint cupidatat",
"gbacWrite": [
"culpa laborum consequat",
"elit dolore deserunt incididunt 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": [
"sint"
],
"members": [],
"_id": "1FF30dCAf8A31B5E7d04cC42",
"description": "aliqua",
"gbacWrite": [
"Lorem tempor in proident",
"fugiat esse Ut",
"in labore veniam"
],
"version": 1
},
"edit": "commodo exercitation"
}
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"
]
}