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