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