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