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