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