{
"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": "eiusmod in voluptate magna",
"original": {
"name": "test",
"gbacRead": [
"ut Lorem quis",
"commodo do velit",
"pariatur cupidatat ut",
"laborum",
"cillum ipsum sed"
],
"members": [],
"_id": "AF64F1a18E6159a371eCee8f",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"dolor",
"aliqua Lorem magna consequat et",
"quis",
"nisi eu in"
],
"members": [],
"_id": "ED0BAA5fada34A064e39AFcD",
"description": "dolor labore ea eiusmod consequat",
"gbacWrite": [
"velit",
"irure Lorem",
"id",
"in voluptate ut eiusmod Duis"
],
"version": 1
},
"edit": null,
"success": false
},
{
"message": "et nisi dolore",
"original": {
"name": "test",
"gbacRead": [
"magna"
],
"members": [],
"_id": "D625CFC644b66F614Adc2e1F",
"version": 1
},
"created": null,
"edit": "pariatur exercitation ut officia",
"success": false
},
{
"message": "nulla occaecat",
"original": {
"name": "test",
"gbacRead": [
"exercitation irure velit aliqua elit",
"ullamco"
],
"members": [],
"_id": "3D4178B69a6f169Aed83C54A",
"version": 1
},
"created": null,
"edit": "mollit ea pariatur do",
"success": false
},
{
"message": "qui",
"original": {
"name": "test",
"gbacRead": [
"dolore esse adipisicing consequat dolor",
"consequat magna sint in",
"qui id Excepteur ut in",
"in quis commodo pariatur enim"
],
"members": [],
"_id": "917eb5B7F5aCf9f10254Aaa6",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"id"
],
"members": [],
"_id": "Aab3c3cbBa4C43ECb022155e",
"description": "fugiat dolor id",
"gbacWrite": [
"ullamco magna ex consectetur",
"in enim sit nulla magna",
"culpa eiusmod tempor",
"culpa dolore veniam sit voluptate",
"aute"
],
"version": 1
},
"edit": "ut fugiat esse eu in",
"success": true
},
{
"message": "ut est consequat laboris sed",
"original": {
"name": "test",
"gbacRead": [
"dolor in dolore",
"minim ipsum pariatur"
],
"members": [],
"_id": "4CB18e5bF8c62055d9D0fD5A",
"version": 1
},
"created": {
"name": "test",
"gbacRead": [
"ut velit",
"Duis dolor",
"velit consequat in mollit nisi",
"nisi aliquip eiusmod voluptate",
"Lorem"
],
"members": [],
"_id": "bcCDDdDF3F115F1220E1D3cB",
"description": "Duis",
"gbacWrite": [
"quis aliquip"
],
"version": 1
},
"edit": "dolor",
"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"
]
}
}
}
}