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": [
"in in labore",
"eiusmod",
"anim dolore tempor in",
"aliqua minim ex in"
],
"members": [],
"_id": "9A8B00abaEBb8e4Ef727C14d",
"description": "amet sit laborum ex",
"gbacWrite": [
"anim nostrud",
"qui anim",
"qui"
],
"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 dolore in",
"dolor culpa fugiat",
"adipisicing amet",
"id in commodo"
],
"members": [],
"_id": "7b1c5Efd3206Df4Bd6B8D7f6",
"description": "minim nostrud dolor sit est",
"gbacWrite": [
"ad",
"deserunt dolore mollit eu",
"enim aliqua adipisicing aliquip",
"laborum consectetur",
"tempor nisi reprehenderit officia aliqua"
],
"version": 1
},
"edit": "occaecat"
}
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"
]
}