Summary
Imports a new component group document.
Description
Imports a new component group document.
Route
POST /automation-studio/component-groups/import
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
componentGroups | array | yes | ComponentGroups array. |
{ "componentGroups": [ { "name": "test", "gbacRead": [ "culpa fugiat tempor sint", "in Lorem culpa cillum ullamco", "Excepteur et tempor id", "in esse culpa" ], "members": [ { "path": "minim", "type": "component", "sourceCollection": "cupidatat adipisicing", "ref": "irure mollit qui" }, { "path": [ "sed fugiat tempor magna", "enim veniam aliqua", "sed esse consectetur sint voluptate", "sed in proident eu", "deserunt qui cupidatat enim" ], "type": "folder" } ], "_id": "C72Eb5d9F859a2C43e6c7f21", "version": 1 } ] }
{ "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
Name | Type | Description |
---|---|---|
response | object | Results from each individual import operation. |
{ "imported": [ { "message": "pariatur", "original": { "name": "test", "gbacRead": [ "voluptate est Ut veniam proident", "veniam sint in", "non ea", "commodo ipsum enim et" ], "members": [ { "path": [ "ipsum officia laborum culpa cupidatat", "commodo magna nisi sit", "mollit deserunt" ], "type": "folder" } ], "_id": "f7af0d473d9cDaB9Cae7ACD5", "version": 1 }, "created": { "name": "test", "gbacRead": [ "fugiat do pariatur", "ut", "incididunt ipsum minim proident", "aute", "proident adipisicing aliqua ut mollit" ], "members": [ { "path": [ "ullamco", "proident", "aliquip", "adipisicing laborum Duis velit", "nisi consectetur" ], "type": "folder" } ], "_id": "d5374c2c3bCFc93356F7caFF", "description": "Lorem cillum anim in proident", "gbacWrite": [ "sint ex", "exercitation velit dolor", "non eu ea", "adipisicing cillum ut", "Excepteur consectetur tempor" ], "version": 1 }, "edit": null, "success": true }, { "message": "pariatur deserunt elit", "original": { "name": "test", "gbacRead": [ "nulla dolor laboris" ], "members": [ { "path": "reprehenderit pariatur", "type": "component", "sourceCollection": "dolor amet in", "ref": "amet do" }, { "path": "consectetur sed culpa mollit", "type": "component", "sourceCollection": "pariatur cupidatat", "ref": "nulla" } ], "_id": "8f7e5aE6e63C3Cb586c14DD0", "version": 1 }, "created": { "name": "test", "gbacRead": [ "ea velit nisi" ], "members": [ { "path": [ "esse voluptate labore dolore nisi", "eu ut quis veniam" ], "type": "folder" }, { "path": [ "sunt eu labore exercitation", "velit" ], "type": "folder" }, { "path": "id commodo qui elit ut", "type": "component", "sourceCollection": "Lorem Ut consectetur", "ref": "aliquip cupidatat irure Ut" } ], "_id": "29d7ca4E5BD12BB6E3a5Bd4F", "description": "fugiat", "gbacWrite": [ "minim ut ipsum proident et", "in magna", "et aliquip amet quis", "sed Ut et velit Duis", "mollit exercitation" ], "version": 1 }, "edit": "dolor", "success": true }, { "message": "sint aute", "original": { "name": "test", "gbacRead": [ "enim id ut esse", "ea ex aute sint culpa", "nulla ad sint", "dolor nulla qui Duis quis" ], "members": [ { "path": [ "nulla in", "anim ea non do" ], "type": "folder" } ], "_id": "f19A89bbCBAd7de2CFe63FF7", "version": 1 }, "created": null, "edit": null, "success": false } ] }
{ "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.", "oneOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "status", "message", "original", "created", "edit" ] } } } }