{
"type": "object",
"properties": {
"componentGroups": {
"title": "componentGroups",
"description": "Array of component group documents to import. If '_id' is provided, it will be replaced with an autogenerated '_id'. If a component group's name is already used in the component groups collection, it will be renamed with a numeric suffix.",
"type": "array",
"items": {
"$ref": "componentGroupImport"
}
}
},
"required": [
"componentGroups"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
response
object
Results from each individual import operation.
Copied to Clipboard
{
"imported": [
{
"message": "qui",
"original": {
"name": "test",
"gbacRead": [
"nulla quis Lorem",
"Excepteur exercitation",
"incididunt voluptate tempor ea"
],
"members": [],
"_id": "F84cB8a2F5a26EF4BA53BF57",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"adipisicing incididunt elit deserunt dolore",
"non pariatur",
"consequat anim ut et Duis"
],
"members": [],
"_id": "0Eb2DcEDcc94a8Ba95A4B68f",
"description": "sed proident nisi tempor",
"gbacWrite": [
"sunt anim ad pariatur",
"ex aute",
"aliquip minim ut enim",
"cillum"
],
"version": 1
},
"edit": "reprehenderit cupidatat ex laboris",
"success": false
},
{
"message": "occaecat aliquip elit consectetur pariatur",
"original": {
"name": "test",
"gbacRead": [
"in enim ea mollit cupidatat",
"irure deserunt nulla",
"sit"
],
"members": [],
"_id": "577f1f0D1f191cb438e7aCc7",
"version": 1
},
"created": null,
"edit": null,
"success": true
},
{
"message": "culpa dolore consectetur in",
"original": {
"name": "test",
"gbacRead": [
"eu ipsum ut nulla",
"id nulla",
"veniam culpa commodo Lorem",
"veniam do ut",
"mollit magna dolore"
],
"members": [],
"_id": "7c6BbF89621DAeAb0491b109",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"Excepteur deserunt nulla ad irure",
"et consectetur",
"Lorem esse irure",
"sint aliqua eiusmod enim consequat",
"commodo non"
],
"members": [],
"_id": "ad32DCdAfF280D22e5A52f1B",
"description": "irure non aliqua",
"gbacWrite": [
"in nulla ullamco esse culpa",
"est veniam et"
],
"version": 1
},
"edit": "nostrud",
"success": false
}
]
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"imported": {
"type": "array",
"items": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "Status flag denoting the success (true) or failure (false) of the component group's import operation."
},
"message": {
"type": "string",
"description": "Message containing either confirmation of the import operation or the reason for the failure of the import operation."
},
"original": {
"description": "The original component group given in the import array.",
"$ref": "componentGroupImport"
},
"created": {
"description": "The imported component group as it exists after being imported.",
"oneOf": [
{
"$ref": "componentGroup"
},
{
"type": "null"
}
]
},
"edit": {
"description": "URI to the edit page for the imported component group.",
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"message",
"original",
"created",
"edit"
]
}
}
}
}