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