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": [
"adipisicing labore culpa id",
"quis laborum reprehenderit est",
"fugiat veniam dolor"
],
"members": [],
"_id": "3Bbd4FB8AEe3AAf4E69db544",
"description": "Duis pariatur ea ut sint",
"gbacWrite": [
"culpa proident nisi ipsum",
"sint",
"officia anim esse et ipsum",
"adipisicing magna",
"cupidatat consequat id proident"
],
"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": [
"ullamco"
],
"members": [],
"_id": "03a6ac02eCa1FC55F9d0DE9D",
"description": "reprehenderit sed",
"gbacWrite": [
"in aliqua id quis",
"deserunt laborum et",
"amet Excepteur et fugiat"
],
"version": 1
},
"edit": "dolore"
}
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"
]
}