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