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": [
"sed qui adipisicing consequat"
],
"members": [
{
"path": [
"minim Excepteur est incididunt",
"exercitation Lorem cillum enim in",
"qui ut id",
"ad",
"exercitation esse commodo"
],
"type": "folder"
}
],
"_id": "0110155A5feC58fe7846DEb7",
"description": "dolore",
"gbacWrite": [
"id enim incididunt",
"amet ut nulla",
"eu dolor Ut culpa"
],
"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": [
"veniam mollit in ullamco non",
"officia nisi amet laboris mollit",
"dolor",
"dolore et pariatur sunt reprehenderit",
"ex voluptate mollit in pariatur"
],
"members": [
{
"path": "ex laborum quis",
"type": "component",
"sourceCollection": "Duis Excepteur Lorem Ut adipisicing",
"ref": "qui id ut"
},
{
"path": "quis nulla magna qui tempor",
"type": "component",
"sourceCollection": "esse anim consectetur ea",
"ref": "amet culpa"
},
{
"path": "elit commodo",
"type": "component",
"sourceCollection": "dolore aliquip in ut",
"ref": "velit"
}
],
"_id": "14CEfAA4A3D0c0ECA585Fcea",
"description": "tempor",
"gbacWrite": [
"commodo et"
],
"version": 1
},
"edit": "ut"
}
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"
]
}