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": [
"sint cupidatat magna",
"sed dolor ex",
"nulla non consectetur",
"ipsum",
"Ut ut Lorem"
],
"members": [
{
"path": "culpa pariatur sit enim id",
"type": "component",
"sourceCollection": "in qui",
"ref": "mollit in id occaecat"
}
],
"_id": "f9bAc5ABFf47FEcf46eadCaf",
"description": "aliqua",
"gbacWrite": [
"labore exercitation eu"
],
"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": [
"laboris ut veniam occaecat irure"
],
"members": [
{
"path": [
"Duis aute ex ut culpa"
],
"type": "folder"
},
{
"path": [
"exercitation",
"culpa qui sint nisi",
"esse laborum do",
"sint ut aliqua adipisicing",
"Ut est dolor sint eu"
],
"type": "folder"
},
{
"path": [
"aliqua mollit in ea"
],
"type": "folder"
}
],
"_id": "FaCbC139c3FFe547Bbf5A1a2",
"description": "ut do est ea eiusmod",
"gbacWrite": [
"exercitation reprehenderit est aute",
"esse proident do dolore",
"laboris id consequat eu sed",
"adipisicing et nisi Duis dolore"
],
"version": 1
},
"edit": "nisi consectetur labore voluptate"
}
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"
]
}