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": [
"et eu nulla consequat",
"ipsum esse laborum",
"exercitation commodo deserunt incididunt occaecat",
"qui nostrud in eu"
],
"members": [
{
"path": [
"eiusmod",
"et ad",
"consequat Lorem dolor",
"adipisicing ex sint dolor"
],
"type": "folder"
},
{
"path": "pariatur ad",
"type": "component",
"sourceCollection": "occaecat",
"ref": "consequat in"
},
{
"path": "in incididunt aute",
"type": "component",
"sourceCollection": "ipsum dolore aute sint quis",
"ref": "esse consequat veniam non"
},
{
"path": [
"et",
"est laboris aute",
"veniam",
"Excepteur",
"eiusmod cillum laboris proident labore"
],
"type": "folder"
}
],
"_id": "b375F53dFAE5Ff225Fe5Caf2",
"description": "magna sed quis",
"gbacWrite": [
"dolore"
],
"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": [
"ipsum ea",
"do laboris aute sed incididunt",
"do dolore adipisicing Excepteur",
"in minim proident sunt",
"veniam minim in nostrud occaecat"
],
"members": [
{
"path": [
"ea consequat et officia sed",
"velit pariatur eu"
],
"type": "folder"
},
{
"path": "laboris consectetur",
"type": "component",
"sourceCollection": "aute",
"ref": "irure cupidatat in commodo"
}
],
"_id": "b9Eb096cBC88eF6d3A4f2a9c",
"description": "commodo",
"gbacWrite": [
"et cupidatat in dolor",
"aliquip cillum",
"aliqua sit ut",
"ipsum",
"consectetur Excepteur"
],
"version": 1
},
"edit": "Duis veniam ullamco"
}
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"
]
}