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": [
"reprehenderit commodo minim",
"ad"
],
"members": [
{
"path": [
"cillum fugiat laboris nulla ut",
"esse ut elit in aute",
"quis magna amet"
],
"type": "folder"
},
{
"path": [
"Excepteur sit",
"elit ullamco velit sed",
"exercitation qui in",
"ex nisi",
"nulla"
],
"type": "folder"
},
{
"path": [
"labore",
"cillum adipisicing",
"veniam sed velit",
"consequat"
],
"type": "folder"
},
{
"path": [
"reprehenderit voluptate cupidatat Lorem minim",
"sit",
"enim",
"Excepteur dolor culpa dolor laborum"
],
"type": "folder"
}
],
"_id": "368c9a6D701BCd9d32E66d76",
"description": "mollit nisi",
"gbacWrite": [
"non pariatur",
"sint"
],
"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": [
"ullamco labore ex consequat ut",
"aliquip ad",
"adipisicing nostrud eiusmod Lorem"
],
"members": [
{
"path": "sint mollit",
"type": "component",
"sourceCollection": "exercitation laboris",
"ref": "proident est nostrud"
},
{
"path": [
"ut deserunt veniam cupidatat",
"dolore",
"non sint",
"consequat cupidatat id magna in",
"ut velit veniam quis nostrud"
],
"type": "folder"
}
],
"_id": "a6ecAE48D27169fF57224c73",
"description": "velit mollit Excepteur incididunt in",
"gbacWrite": [
"aute",
"ea"
],
"version": 1
},
"edit": "dolore"
}
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"
]
}