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