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": [
"fugiat",
"in pariatur qui et occaecat",
"aliqua",
"deserunt magna dolore enim anim"
],
"members": [],
"_id": "8474a7Ae5e98Ad4f6CF93b4C",
"description": "qui Lorem",
"gbacWrite": [
"nisi quis",
"consequat"
],
"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": [
"aute adipisicing sunt in culpa",
"velit dolor fugiat eiusmod"
],
"members": [],
"_id": "C82E76dDEaA65AfEd50e4ff0",
"description": "cupidatat eu non ut",
"gbacWrite": [
"ex magna aliqua ea sit",
"cupidatat sed",
"nulla aliquip veniam occaecat nisi"
],
"version": 1
},
"edit": "elit tempor ut aute eu"
}
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"
]
}