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": [
"mollit do veniam adipisicing",
"sit id ullamco",
"qui veniam sit",
"sed tempor consectetur"
],
"members": [
{
"path": "aliquip ad nulla ipsum",
"type": "component",
"sourceCollection": "cupidatat ex et labore ea",
"ref": "deserunt"
}
],
"_id": "9EeAf85DC4F9EeD6fda5a933",
"description": "et",
"gbacWrite": [
"nisi",
"aliqua Ut ad laboris tempor",
"ullamco do et nisi",
"quis reprehenderit et pariatur do",
"laboris labore mollit"
],
"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": [
"enim aliqua do",
"in eiusmod sunt Excepteur",
"dolore eiusmod do nulla",
"incididunt consequat",
"eiusmod occaecat eu esse magna"
],
"members": [
{
"path": "nisi Excepteur",
"type": "component",
"sourceCollection": "adipisicing fugiat consectetur",
"ref": "commodo exercitation dolore enim nostrud"
},
{
"path": [
"non amet mollit sed",
"nulla officia"
],
"type": "folder"
}
],
"_id": "2550bD4F9fEd4fdE96f60dAA",
"description": "velit anim",
"gbacWrite": [
"ad",
"Excepteur",
"ad in sint aute ut"
],
"version": 1
},
"edit": "labore reprehenderit exercitation magna"
}
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"
]
}