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