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