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": [ "nostrud ea sint amet", "Ut in", "Ut consectetur elit", "mollit aliquip in et" ], "members": [ { "path": "in sint", "type": "component", "sourceCollection": "ea sit ipsum dolore eu", "ref": "fugiat ipsum aliquip id eu" } ], "_id": "0Ad7fc624cFfcBA5a2A53e7D", "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": "eu veniam consectetur laboris", "original": { "name": "test", "gbacRead": [ "nisi cillum tempor consectetur", "mollit", "adipisicing exercitation", "amet ullamco" ], "members": [ { "path": [ "ad aliqua cillum nisi amet", "laboris Duis sed", "ipsum esse aliquip", "elit id" ], "type": "folder" }, { "path": [ "minim anim", "commodo esse mollit fugiat", "in" ], "type": "folder" } ], "_id": "3BD4A2D3DFecF35F22E0DBd5", "version": 1 }, "created": { "name": "test", "gbacRead": [ "et sit sunt elit Lorem", "do consectetur irure", "in reprehenderit", "voluptate ea", "labore" ], "members": [ { "path": [ "quis ea occaecat", "sunt" ], "type": "folder" }, { "path": [ "Lorem adipisicing sed sunt do", "nulla" ], "type": "folder" }, { "path": [ "Excepteur mollit est enim", "nulla", "reprehenderit", "cupidatat ut", "id" ], "type": "folder" } ], "_id": "aEabEaFedE0e31227cccc40c", "description": "dolore id anim in", "gbacWrite": [ "nostrud et", "tempor Ut minim et", "reprehenderit" ], "version": 1 }, "edit": "voluptate sed dolore Duis nulla", "success": true }, { "message": "incididunt in ut", "original": { "name": "test", "gbacRead": [ "aliquip velit nisi culpa", "non Lorem", "est reprehenderit laborum id" ], "members": [ { "path": "eiusmod elit", "type": "component", "sourceCollection": "fugiat aliquip", "ref": "fugiat" }, { "path": "non enim dolor eu irure", "type": "component", "sourceCollection": "proident eiusmod sunt", "ref": "deserunt sint nisi enim" }, { "path": [ "ullamco cupidatat dolor dolore", "ea nostrud cupidatat amet minim", "esse", "ad ut in", "sint" ], "type": "folder" } ], "_id": "6D58Fa3eDACcBBE64AbeDd0f", "version": 1 }, "created": { "name": "test", "gbacRead": [ "dolor do" ], "members": [ { "path": [ "incididunt" ], "type": "folder" } ], "_id": "7EC5dcbfDecf210133CF7F92", "description": "ad", "gbacWrite": [ "deserunt aliquip nostrud sed", "et", "incididunt occaecat", "in proident" ], "version": 1 }, "edit": null, "success": false }, { "message": "dolor velit", "original": { "name": "test", "gbacRead": [ "commodo cillum" ], "members": [ { "path": [ "reprehenderit ut velit", "in aute veniam enim laborum", "labore reprehenderit" ], "type": "folder" }, { "path": "enim Excepteur eu reprehenderit", "type": "component", "sourceCollection": "minim", "ref": "ex in commodo veniam" }, { "path": [ "nostrud", "ea" ], "type": "folder" }, { "path": [ "nulla quis labore sit", "elit dolor consectetur incididunt et" ], "type": "folder" } ], "_id": "73C22FFDCAD7c45d2ff4B8F7", "version": 1 }, "created": null, "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" ] } } } }