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": [
"magna nostrud",
"in"
],
"members": [
{
"path": "in cillum Lorem incididunt",
"type": "component",
"sourceCollection": "voluptate reprehenderit dolore",
"ref": "eiusmod ex Lorem nostrud"
},
{
"path": "irure culpa commodo consequat amet",
"type": "component",
"sourceCollection": "qui",
"ref": "Duis laborum minim ut ipsum"
}
],
"_id": "1f0D25c861e69cE5dc5a6A3E",
"description": "dolore",
"gbacWrite": [
"laboris exercitation voluptate in",
"ullamco ea esse aute quis",
"veniam id",
"magna Duis ut aute enim",
"occaecat"
],
"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": [
"exercitation labore magna in",
"eiusmod dolor magna ipsum"
],
"members": [
{
"path": "laboris exercitation quis anim dolor",
"type": "component",
"sourceCollection": "dolore exercitation nostrud et ut",
"ref": "Lorem Excepteur adipisicing"
}
],
"_id": "5cB75e9EBffd0ffD2bcFCD2F",
"description": "fugiat eu anim Excepteur",
"gbacWrite": [
"Ut reprehenderit eiusmod dolor do"
],
"version": 1
},
"edit": "laborum esse"
}
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"
]
}