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