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": [
"anim sit ea consectetur esse",
"dolore eiusmod",
"reprehenderit pariatur",
"irure ut dolor"
],
"members": [
{
"path": "laboris",
"type": "component",
"sourceCollection": "aliquip",
"ref": "nostrud occaecat dolore"
}
],
"_id": "cD93deBEA7CCf9B3eAb070CE",
"description": "ullamco qui est id",
"gbacWrite": [
"exercitation minim",
"sunt eiusmod adipisicing",
"ut cupidatat laborum",
"nulla in amet reprehenderit"
],
"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": [
"dolor pariatur dolore tempor non",
"ullamco voluptate sunt",
"minim"
],
"members": [
{
"path": [
"laboris elit qui sit eu",
"incididunt Excepteur",
"nostrud et dolore incididunt",
"Ut eu officia",
"nulla sint fugiat"
],
"type": "folder"
},
{
"path": "dolor",
"type": "component",
"sourceCollection": "anim qui deserunt",
"ref": "Lorem Ut"
},
{
"path": "voluptate quis esse",
"type": "component",
"sourceCollection": "esse adipisicing dolore",
"ref": "ullamco irure"
}
],
"_id": "48C1A0ebE9C8bEB4B48cC7DD",
"description": "aute veniam cillum",
"gbacWrite": [
"aute fugiat amet ad",
"velit ipsum ullamco sed",
"eiusmod sint sunt"
],
"version": 1
},
"edit": "sunt 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"
]
}