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": [
"consectetur aliqua",
"aliquip dolore",
"incididunt",
"officia minim mollit Ut",
"officia irure magna sint mollit"
],
"members": [
{
"path": "ex dolor",
"type": "component",
"sourceCollection": "do Excepteur pariatur exercitation",
"ref": "do"
}
],
"_id": "F17A747FA5B73EFC55A71A57",
"description": "quis ea adipisicing ullamco",
"gbacWrite": [
"Lorem aliqua labore anim"
],
"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": [
"minim",
"consectetur ut",
"voluptate esse labore elit amet"
],
"members": [
{
"path": "tempor ut aute fugiat",
"type": "component",
"sourceCollection": "ut non voluptate dolor",
"ref": "in exercitation ut fugiat"
},
{
"path": [
"ut proident ad id",
"in eu",
"dolore tempor",
"sint Lorem dolor incididunt est"
],
"type": "folder"
}
],
"_id": "Ed03f04152d8Bec50F4FD3de",
"description": "dolore quis",
"gbacWrite": [
"laboris labore ad commodo eiusmod",
"nisi non Ut occaecat elit",
"fugiat reprehenderit quis do nostrud",
"ipsum nisi id consequat Lorem"
],
"version": 1
},
"edit": "nostrud enim mollit"
}
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"
]
}