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": [ "aliquip est aliqua in", "fugiat officia", "nostrud in voluptate esse velit" ], "members": [ { "path": [ "exercitation", "elit", "est proident aute deserunt" ], "type": "folder" }, { "path": [ "in nulla et consectetur veniam", "reprehenderit ea dolor nostrud dolore", "labore proident nisi ex cillum", "labore ut" ], "type": "folder" }, { "path": "non", "type": "component", "sourceCollection": "fugiat mollit incididunt pariatur aute", "ref": "reprehenderit incididunt" }, { "path": "veniam sit ad", "type": "component", "sourceCollection": "deserunt do ea Excepteur eiusmod", "ref": "eiusmod nostrud nulla consectetur proident" }, { "path": [ "et in dolor sed", "fugiat deserunt sit" ], "type": "folder" } ], "_id": "eFB3A8de67ba1Cb6a4B4eB6E", "version": 1 }, { "name": "test", "gbacRead": [ "proident nostrud elit mollit" ], "members": [ { "path": "est nisi", "type": "component", "sourceCollection": "in elit in id", "ref": "ullamco officia dolor ea proident" }, { "path": [ "elit tempor id laborum" ], "type": "folder" }, { "path": "officia pariatur", "type": "component", "sourceCollection": "aliqua", "ref": "ex dolor elit ut occaecat" }, { "path": [ "et pariatur", "proident", "adipisicing eiusmod in irure" ], "type": "folder" }, { "path": [ "ex sed enim", "culpa ullamco mollit ea irure", "nostrud laborum", "anim do labore", "ex" ], "type": "folder" } ], "_id": "efE70E22CD0333b9DaA501B4", "version": 1 }, { "name": "test", "gbacRead": [ "dolore laboris", "ad Duis voluptate" ], "members": [ { "path": "Lorem amet culpa laborum in", "type": "component", "sourceCollection": "nulla quis cillum", "ref": "amet nisi ut" }, { "path": [ "mollit", "enim fugiat proident", "ad veniam eu ullamco laboris", "ex eiusmod Excepteur ipsum fugiat" ], "type": "folder" }, { "path": [ "in", "aliqua sit ex" ], "type": "folder" } ], "_id": "F8cc51dfFDe63Fc3f83A9399", "version": 1 }, { "name": "test", "gbacRead": [ "aute in cupidatat est", "ullamco" ], "members": [ { "path": [ "sed in dolor dolore", "veniam Ut in" ], "type": "folder" }, { "path": [ "aliqua labore in exercitation sit", "irure officia Ut veniam", "sunt commodo est", "enim elit tempor ut sit" ], "type": "folder" } ], "_id": "Fd7AC3dD31eD3AB091A80d16", "version": 1 }, { "name": "test", "gbacRead": [ "sit mollit", "eu nisi", "aute reprehenderit sint eu consequat", "adipisicing proident in labore velit" ], "members": [ { "path": [ "Ut" ], "type": "folder" }, { "path": "irure qui Excepteur laborum sit", "type": "component", "sourceCollection": "tempor nisi cillum in", "ref": "in Ut mollit irure" }, { "path": [ "consectetur non Lorem pariatur magna", "qui", "dolore qui", "aute est", "id deserunt" ], "type": "folder" } ], "_id": "0fC400A5a9b6AcaeCFDD6A69", "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": "occaecat deserunt et dolor", "original": { "name": "test", "gbacRead": [ "sint sit deserunt amet dolore", "pariatur ut culpa aliqua aute", "minim", "in aliqua nisi tempor" ], "members": [ { "path": "officia ea consectetur fugiat sit", "type": "component", "sourceCollection": "in pariatur dolor nulla", "ref": "proident nisi consectetur" } ], "_id": "90EdbB58C05aCfF25dB32AcC", "version": 1 }, "created": { "name": "test", "gbacRead": [ "sint Excepteur", "consequat quis ea sed", "anim", "nostrud ullamco", "tempor" ], "members": [ { "path": [ "culpa non mollit id", "dolore", "mollit ut tempor cillum" ], "type": "folder" }, { "path": "adipisicing", "type": "component", "sourceCollection": "commodo", "ref": "eu sunt" }, { "path": [ "id sit", "id consectetur nulla", "Lorem" ], "type": "folder" }, { "path": "nulla irure", "type": "component", "sourceCollection": "exercitation culpa id", "ref": "laborum velit sed pariatur" } ], "_id": "9dC9Dc7b2DddCf38DDCB5ceB", "description": "velit ullamco consectetur labore esse", "gbacWrite": [ "elit minim", "exercitation", "ullamco sunt laborum Duis in", "cupidatat", "in" ], "version": 1 }, "edit": null, "success": true }, { "message": "ut do Duis nisi", "original": { "name": "test", "gbacRead": [ "nisi exercitation", "esse dolore nisi" ], "members": [ { "path": [ "magna incididunt anim Duis id", "culpa quis", "enim anim deserunt" ], "type": "folder" }, { "path": "in proident", "type": "component", "sourceCollection": "cupidatat eiusmod ad", "ref": "officia magna in dolor" } ], "_id": "2E3c668E2B2ce3ff84449B5d", "version": 1 }, "created": { "name": "test", "gbacRead": [ "Duis ut et Excepteur" ], "members": [ { "path": "aliquip ipsum ea cupidatat", "type": "component", "sourceCollection": "in Lorem deserunt", "ref": "nulla adipisicing Lorem" }, { "path": [ "commodo irure id Ut", "velit et laboris", "exercitation in ut ad commodo" ], "type": "folder" }, { "path": "labore", "type": "component", "sourceCollection": "anim ipsum", "ref": "ea in" }, { "path": [ "dolore" ], "type": "folder" } ], "_id": "5A2FDEfd41738608E334B097", "description": "reprehenderit culpa", "gbacWrite": [ "dolore enim irure labore sed", "sunt occaecat amet commodo" ], "version": 1 }, "edit": null, "success": true }, { "message": "Excepteur", "original": { "name": "test", "gbacRead": [ "eu id amet sed" ], "members": [ { "path": "exercitation", "type": "component", "sourceCollection": "consectetur in", "ref": "irure magna" }, { "path": [ "laboris ad in deserunt", "ex adipisicing", "pariatur veniam", "incididunt ullamco ex", "id aliqua magna dolor in" ], "type": "folder" }, { "path": "est officia et", "type": "component", "sourceCollection": "sed dolor Lorem", "ref": "sunt" } ], "_id": "46D2De6e3bC956f84DfC630C", "version": 1 }, "created": null, "edit": "voluptate magna fugiat ad dolore", "success": false }, { "message": "elit exercitation esse irure", "original": { "name": "test", "gbacRead": [ "ullamco exercitation", "eu commodo", "non aute nulla sed" ], "members": [ { "path": [ "nostrud", "do" ], "type": "folder" }, { "path": "exercitation anim minim veniam", "type": "component", "sourceCollection": "dolor sint commodo enim aute", "ref": "Duis ea Lorem mollit" }, { "path": "labore pariatur ad", "type": "component", "sourceCollection": "sit aliquip tempor", "ref": "esse" }, { "path": "aute enim ea deserunt quis", "type": "component", "sourceCollection": "deserunt nulla tempor", "ref": "ipsum dolor" }, { "path": [ "nulla sed dolore deserunt", "in adipisicing laborum eu culpa", "laborum Excepteur Duis culpa mollit", "exercitation fugiat laborum occaecat" ], "type": "folder" } ], "_id": "D6f3CAc28eaB3C5D5C57fdBe", "version": 1 }, "created": null, "edit": null, "success": true }, { "message": "amet eiusmod do et", "original": { "name": "test", "gbacRead": [ "consequat", "occaecat reprehenderit Lorem sit" ], "members": [ { "path": [ "Lorem officia" ], "type": "folder" }, { "path": "dolor reprehenderit incididunt", "type": "component", "sourceCollection": "consequat sint laboris esse", "ref": "aliqua dolore qui" }, { "path": [ "dolor laborum qui ex", "reprehenderit aute" ], "type": "folder" } ], "_id": "A8F7f1DA4E5dC6E0a3Bdcc2f", "version": 1 }, "created": null, "edit": "esse laboris cupidatat culpa", "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" ] } } } }