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 ex magna cupidatat irure",
"proident anim cillum incididunt",
"aliquip officia non Lorem cupidatat",
"ipsum",
"in"
],
"members": [
{
"path": "est ipsum mollit aliquip id",
"type": "component",
"sourceCollection": "anim",
"ref": "Duis dolor in ullamco"
},
{
"path": "adipisicing Duis reprehenderit Lorem",
"type": "component",
"sourceCollection": "id",
"ref": "sunt in"
},
{
"path": "reprehenderit deserunt",
"type": "component",
"sourceCollection": "consequat",
"ref": "pariatur aute"
},
{
"path": "quis esse aliquip",
"type": "component",
"sourceCollection": "in exercitation est sunt",
"ref": "ipsum commodo quis elit enim"
}
],
"_id": "3f6eAF159C35eAfBBaF1fEDe",
"description": "Lorem consectetur velit aute et",
"gbacWrite": [
"elit dolore in nulla",
"amet occaecat",
"minim elit magna ipsum dolore",
"laboris tempor consectetur",
"officia aute culpa aliqua"
],
"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 ipsum deserunt culpa non",
"in ullamco",
"labore",
"eiusmod aute quis reprehenderit laborum"
],
"members": [
{
"path": [
"ut qui veniam Lorem aute",
"amet",
"dolor",
"consequat Ut occaecat ipsum"
],
"type": "folder"
}
],
"_id": "501cCB7eaAcCE7DBECCB3eFf",
"description": "dolor ut",
"gbacWrite": [
"do nisi qui occaecat",
"labore sed velit magna",
"reprehenderit et velit nostrud"
],
"version": 1
},
"edit": "culpa"
}
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"
]
}