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": [
"elit",
"pariatur ad Excepteur",
"amet magna laborum sed consectetur",
"occaecat sint",
"ullamco dolore aute eiusmod"
],
"members": [
{
"path": [
"non Lorem nulla"
],
"type": "folder"
},
{
"path": [
"veniam dolore mollit laboris"
],
"type": "folder"
},
{
"path": [
"amet fugiat sint magna",
"in Lorem deserunt dolor",
"incididunt",
"nostrud velit",
"magna cupidatat anim"
],
"type": "folder"
},
{
"path": [
"ea proident fugiat sed",
"est esse in do dolor"
],
"type": "folder"
}
],
"_id": "d01aEdCc2DdD0aAA0Ae92aAc",
"description": "tempor",
"gbacWrite": [
"consectetur esse",
"ut ad Ut enim",
"aliqua dolor Ut nulla ex",
"occaecat veniam qui",
"consequat"
],
"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 ut",
"qui"
],
"members": [
{
"path": [
"sunt minim Duis",
"aliqua quis",
"in",
"fugiat ipsum"
],
"type": "folder"
},
{
"path": "deserunt laboris",
"type": "component",
"sourceCollection": "elit labore non ea",
"ref": "Lorem consequat veniam consectetur"
},
{
"path": [
"consequat dolor dolore"
],
"type": "folder"
}
],
"_id": "16651C3E2ac9AD5C46ef5BB7",
"description": "ipsum reprehenderit irure voluptate",
"gbacWrite": [
"Excepteur eiusmod voluptate Ut",
"et",
"mollit reprehenderit",
"dolore laboris commodo Duis"
],
"version": 1
},
"edit": "aute non ut pariatur in"
}
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"
]
}