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": [
"esse aute tempor officia",
"officia sed consequat Excepteur",
"aliquip",
"ad quis minim deserunt qui"
],
"members": [],
"_id": "CE1e14a65B70A12e9b5a2A31",
"description": "Ut ex",
"gbacWrite": [
"voluptate occaecat",
"ullamco proident occaecat mollit",
"enim sint",
"do est cupidatat minim"
],
"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": [
"velit",
"nisi ut ea incididunt irure",
"laboris Duis nisi"
],
"members": [],
"_id": "BbCa2350b4b198FeF2fafe6c",
"description": "consequat aliqua in anim et",
"gbacWrite": [
"in deserunt",
"consequat officia",
"cillum veniam eu voluptate"
],
"version": 1
},
"edit": "cupidatat ut dolor nostrud cillum"
}
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"
]
}