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