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