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": [
"minim consequat officia occaecat velit",
"cupidatat ad proident Excepteur",
"cillum sunt ea proident ad",
"laboris aute"
],
"members": [
{
"path": [
"est do"
],
"type": "folder"
}
],
"_id": "F5B9Dd6cD59ceB28E9E1f193",
"description": "cupidatat Duis non mollit",
"gbacWrite": [
"dolor velit eiusmod",
"ea Lorem dolore sit",
"sint incididunt velit",
"veniam qui enim nulla",
"labore do aliquip 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": [
"cillum",
"in",
"Lorem est id",
"sint officia sunt"
],
"members": [
{
"path": [
"Excepteur",
"magna esse",
"in dolore aliqua veniam",
"Lorem sed reprehenderit cillum fugiat"
],
"type": "folder"
},
{
"path": [
"irure quis Excepteur pariatur",
"laborum non Lorem adipisicing culpa",
"veniam elit nisi consequat",
"dolor sint",
"culpa labore minim officia laborum"
],
"type": "folder"
},
{
"path": [
"officia",
"pariatur",
"proident qui consectetur",
"incididunt dolor",
"magna incididunt sint"
],
"type": "folder"
},
{
"path": "reprehenderit ullamco",
"type": "component",
"sourceCollection": "irure esse minim quis",
"ref": "deserunt laborum"
},
{
"path": "quis aliquip officia ut",
"type": "component",
"sourceCollection": "dolore dolor ut exercitation elit",
"ref": "et esse officia"
}
],
"_id": "70ABdE1BaE390Aa88B8Ec2a7",
"description": "magna anim veniam consectetur ut",
"gbacWrite": [
"ullamco velit labore",
"consequat ad voluptate laborum eu",
"irure sunt",
"veniam",
"id"
],
"version": 1
},
"edit": "proident enim"
}
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"
]
}
