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": [ "minim", "consequat adipisicing incididunt" ], "members": [ { "path": "magna officia eiusmod", "type": "component", "sourceCollection": "dolor nisi eiusmod tempor dolor", "ref": "anim" } ], "_id": "1C55Eb2CE0BBc11bD76DacDB", "version": 1 }, { "name": "test", "gbacRead": [ "aute sed in laborum non", "in non" ], "members": [ { "path": [ "cupidatat Ut nisi" ], "type": "folder" } ], "_id": "0F0180Cb6cC9de1aC3E1aD66", "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing", "dolore laborum", "elit in aliquip", "mollit Ut in ut" ], "members": [ { "path": [ "non sunt anim", "sed esse sunt tempor", "do tempor consectetur sit", "qui cillum nostrud", "eu proident" ], "type": "folder" }, { "path": [ "velit reprehenderit" ], "type": "folder" }, { "path": "in sunt ullamco labore in", "type": "component", "sourceCollection": "incididunt cillum commodo minim", "ref": "Lorem consequat sit pariatur consectetur" }, { "path": "et", "type": "component", "sourceCollection": "laboris sint mollit ea", "ref": "esse id Excepteur magna Ut" } ], "_id": "cacea345eeb1EbA0ACb8cFcf", "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": "sed anim id Lorem", "original": { "name": "test", "gbacRead": [ "Ut consectetur cupidatat aliquip", "dolore ut mollit ex", "elit ea in ipsum sint", "cillum sunt anim" ], "members": [ { "path": "Excepteur est", "type": "component", "sourceCollection": "do elit sint", "ref": "pariatur Excepteur sit" }, { "path": [ "dolore exercitation nostrud", "reprehenderit", "aute commodo fugiat", "eu ut cillum ullamco" ], "type": "folder" }, { "path": [ "laboris reprehenderit irure voluptate", "commodo", "veniam tempor voluptate irure", "aute" ], "type": "folder" }, { "path": "magna sint enim", "type": "component", "sourceCollection": "eiusmod", "ref": "esse" } ], "_id": "2f925eEd2436B2b9B0b71C89", "version": 1 }, "created": null, "edit": null, "success": true }, { "message": "et ipsum reprehenderit nostrud", "original": { "name": "test", "gbacRead": [ "proident", "aute magna", "proident culpa ipsum non reprehenderit" ], "members": [ { "path": "eiusmod", "type": "component", "sourceCollection": "dolor sunt ut Lorem et", "ref": "dolor" }, { "path": [ "amet ea cupidatat", "cillum quis", "incididunt ullamco irure", "ipsum ut", "Excepteur ullamco deserunt" ], "type": "folder" }, { "path": "quis Duis in nisi adipisicing", "type": "component", "sourceCollection": "laborum esse exercitation in velit", "ref": "id ea eu nisi sint" } ], "_id": "24b6dAcF607B3edF7E2e68eA", "version": 1 }, "created": null, "edit": "Excepteur in anim deserunt", "success": false }, { "message": "sunt in eu Excepteur", "original": { "name": "test", "gbacRead": [ "sed ullamco", "velit ullamco ad aliqua" ], "members": [ { "path": [ "Lorem ullamco" ], "type": "folder" }, { "path": [ "quis veniam", "aliqua cupidatat", "nulla sint", "mollit Duis", "aute adipisicing dolore" ], "type": "folder" } ], "_id": "bb8bDeA6ED984BEd17927cf1", "version": 1 }, "created": { "name": "test", "gbacRead": [ "ad incididunt commodo" ], "members": [ { "path": [ "incididunt occaecat amet" ], "type": "folder" }, { "path": "ullamco", "type": "component", "sourceCollection": "Excepteur", "ref": "dolore aliqua nulla deserunt" } ], "_id": "DF5EC93a3A5ffcF48C693fbF", "description": "officia", "gbacWrite": [ "deserunt reprehenderit incididunt consequat ullamco" ], "version": 1 }, "edit": null, "success": true } ] }
{ "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" ] } } } }