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": [ "elit ad sunt", "aute consequat eu", "velit ullamco adipisicing in" ], "members": [ { "path": "culpa dolor in do", "type": "component", "sourceCollection": "est anim reprehenderit magna", "ref": "in ex consequat pariatur" }, { "path": [ "aliqua laborum exercitation sint" ], "type": "folder" }, { "path": "deserunt Lorem nisi sed sunt", "type": "component", "sourceCollection": "ad", "ref": "ullamco est ex incididunt quis" }, { "path": "amet aliqua dolore dolor", "type": "component", "sourceCollection": "Ut Lorem eiusmod", "ref": "minim dolor in Ut" }, { "path": "in sunt cillum consectetur elit", "type": "component", "sourceCollection": "anim", "ref": "anim" } ], "_id": "e6980eD96AD8e0Fd5917a8aA", "version": 1 }, { "name": "test", "gbacRead": [ "id esse" ], "members": [ { "path": "magna minim adipisicing", "type": "component", "sourceCollection": "ut sed veniam", "ref": "et dolor aliqua dolor anim" }, { "path": "sint adipisicing", "type": "component", "sourceCollection": "non", "ref": "do" } ], "_id": "452c119cb7F5555d0815d0fC", "version": 1 }, { "name": "test", "gbacRead": [ "sint dolore sit nisi", "commodo eiusmod ut", "fugiat sit Lorem", "culpa ullamco id amet Ut", "adipisicing in enim" ], "members": [ { "path": [ "aliqua anim enim Duis nulla" ], "type": "folder" }, { "path": [ "velit aute culpa in elit" ], "type": "folder" }, { "path": [ "quis in", "aliquip nisi ut dolore consequat" ], "type": "folder" }, { "path": "dolor sint exercitation", "type": "component", "sourceCollection": "ipsum sed nisi", "ref": "ullamco aliquip fugiat cupidatat" } ], "_id": "eeDCE711167b05aE7E7Fd8f7", "version": 1 }, { "name": "test", "gbacRead": [ "ex dolore irure in", "ut aute non tempor" ], "members": [ { "path": "irure", "type": "component", "sourceCollection": "ut", "ref": "est nisi in ullamco velit" }, { "path": [ "Excepteur amet" ], "type": "folder" } ], "_id": "B7c14DCF9c4AE4EE7944abb8", "version": 1 }, { "name": "test", "gbacRead": [ "labore velit cupidatat dolore", "velit", "dolore irure in Lorem sed", "in", "Lorem cupidatat velit ut eiusmod" ], "members": [ { "path": "Lorem", "type": "component", "sourceCollection": "mollit nostrud non", "ref": "sint ipsum ea nisi" }, { "path": [ "dolor", "laborum", "est", "amet velit tempor", "proident est veniam quis laborum" ], "type": "folder" }, { "path": [ "sit id consectetur Excepteur non", "incididunt" ], "type": "folder" } ], "_id": "a0cc25dE7FB269fC2E1A8d2d", "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": "sit dolore et dolor dolor", "original": { "name": "test", "gbacRead": [ "ut aliqua", "ad commodo", "pariatur" ], "members": [ { "path": [ "sunt consectetur", "cillum aute enim proident", "laboris Excepteur consectetur enim", "ad dolore minim" ], "type": "folder" } ], "_id": "eF92136EBCb67EA3511F46FF", "version": 1 }, "created": { "name": "test", "gbacRead": [ "eu ad deserunt Duis", "exercitation in occaecat commodo", "dolore in", "laboris" ], "members": [ { "path": [ "consectetur Excepteur quis", "id", "mollit" ], "type": "folder" }, { "path": "id do nostrud", "type": "component", "sourceCollection": "quis dolore labore dolor et", "ref": "laborum" }, { "path": "elit labore irure", "type": "component", "sourceCollection": "fugiat proident est cillum", "ref": "ex ut aute do dolore" }, { "path": [ "nostrud commodo dolore", "incididunt ullamco do" ], "type": "folder" }, { "path": [ "in ut est nisi Lorem", "anim consequat in voluptate nostrud", "aliqua culpa", "ex cupidatat do", "Lorem incididunt velit ipsum ad" ], "type": "folder" } ], "_id": "8DE97A80De3f9081bdA3acd6", "description": "cillum nulla nisi", "gbacWrite": [ "qui enim dolore elit in" ], "version": 1 }, "edit": null, "success": true }, { "message": "Excepteur ipsum id", "original": { "name": "test", "gbacRead": [ "sit consectetur officia ut" ], "members": [ { "path": [ "voluptate ipsum ut aute tempor" ], "type": "folder" }, { "path": [ "incididunt consectetur do dolore" ], "type": "folder" }, { "path": [ "aliqua ut ullamco mollit in" ], "type": "folder" } ], "_id": "0A51F41dcbbdf6DCcd671144", "version": 1 }, "created": { "name": "test", "gbacRead": [ "fugiat laboris enim", "tempor ipsum Duis minim est" ], "members": [ { "path": [ "in incididunt culpa", "eiusmod nisi Ut pariatur", "cillum elit", "deserunt eu", "tempor" ], "type": "folder" }, { "path": [ "dolor" ], "type": "folder" }, { "path": "dolore ad deserunt", "type": "component", "sourceCollection": "officia Ut", "ref": "velit do" }, { "path": "sed", "type": "component", "sourceCollection": "quis laborum officia incididunt magna", "ref": "officia cupidatat aute" }, { "path": "reprehenderit eu Duis dolore", "type": "component", "sourceCollection": "ex non cillum veniam", "ref": "ipsum" } ], "_id": "aBBe5FbBf1Fc6e3EB532f951", "description": "cupidatat Lorem deserunt", "gbacWrite": [ "qui", "in do occaecat eiusmod amet", "labore aliqua" ], "version": 1 }, "edit": null, "success": true }, { "message": "occaecat exercitation", "original": { "name": "test", "gbacRead": [ "velit Ut est quis ullamco", "culpa laboris dolore", "eu", "ex Duis sed" ], "members": [ { "path": [ "est ipsum" ], "type": "folder" }, { "path": "laboris fugiat", "type": "component", "sourceCollection": "quis ullamco commodo magna", "ref": "ex voluptate quis ut" }, { "path": "aliqua ex", "type": "component", "sourceCollection": "enim sit fugiat veniam ut", "ref": "incididunt" }, { "path": "mollit", "type": "component", "sourceCollection": "sed et id dolore", "ref": "sit ut in" }, { "path": "dolore aliqua officia Excepteur anim", "type": "component", "sourceCollection": "amet incididunt", "ref": "in ad ex velit enim" } ], "_id": "85F5C6aFcBe5FaDa48a9d3F6", "version": 1 }, "created": null, "edit": null, "success": false }, { "message": "labore id nisi sunt", "original": { "name": "test", "gbacRead": [ "do sit reprehenderit exercitation qui" ], "members": [ { "path": [ "eiusmod est non elit", "dolor sunt", "commodo Lorem", "do proident culpa ea", "ipsum incididunt dolore nostrud" ], "type": "folder" }, { "path": "nisi proident laboris dolore", "type": "component", "sourceCollection": "incididunt pariatur ut", "ref": "nulla nostrud" }, { "path": "mollit commodo ad cillum est", "type": "component", "sourceCollection": "reprehenderit magna Ut est consectetur", "ref": "consequat cillum eiusmod" } ], "_id": "CEb0F8bc5fDA1ce0bBBBeAa8", "version": 1 }, "created": null, "edit": "nulla est", "success": true }, { "message": "ut Ut", "original": { "name": "test", "gbacRead": [ "nostrud sunt consequat voluptate minim", "exercitation", "voluptate ipsum dolore sed aliquip", "sed anim quis" ], "members": [ { "path": [ "in Ut Excepteur velit culpa", "qui", "exercitation pariatur Duis adipisicing anim", "aliquip culpa esse Lorem", "commodo veniam elit in" ], "type": "folder" }, { "path": [ "et esse velit", "fugiat anim consectetur veniam" ], "type": "folder" }, { "path": "nostrud reprehenderit", "type": "component", "sourceCollection": "esse exercitation adipisicing est", "ref": "exercitation ea anim amet" } ], "_id": "757FCADd4Fe76f8cC39Db1D1", "version": 1 }, "created": null, "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" ] } } } }