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": [
"et ut nisi pariatur"
],
"members": [],
"_id": "f5Fad90fB9AE9FB254F4e4C2",
"description": "sed",
"gbacWrite": [
"ad velit in",
"nostrud consectetur",
"adipisicing in enim sit",
"ex enim dolore eiusmod occaecat"
],
"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 Excepteur eu",
"cillum esse sed",
"in sed",
"est sunt et",
"nulla nostrud Duis"
],
"members": [],
"_id": "77bc8fdEFdb08ea9D957874d",
"description": "culpa consequat veniam est quis",
"gbacWrite": [
"eu in",
"esse sint est",
"reprehenderit Duis",
"id irure",
"eiusmod"
],
"version": 1
},
"edit": "cupidatat"
}
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"
]
}