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": [ "reprehenderit amet laborum", "velit" ], "members": [ { "path": "eiusmod est dolore aliqua Lorem", "type": "component", "sourceCollection": "occaecat aliqua Ut fugiat", "ref": "pariatur esse sunt eiusmod" }, { "path": "ipsum amet irure dolor", "type": "component", "sourceCollection": "sint ullamco eiusmod ipsum et", "ref": "officia do ex" } ], "_id": "Eb699Fb79caa3EA139E0a7dC", "version": 1 }, { "name": "test", "gbacRead": [ "culpa nulla ut amet exercitation", "dolor ut" ], "members": [ { "path": [ "sit consectetur et veniam", "in veniam proident aliquip aute", "minim adipisicing", "non dolor" ], "type": "folder" }, { "path": "nostrud commodo occaecat veniam", "type": "component", "sourceCollection": "consequat ipsum Ut", "ref": "aute culpa" }, { "path": "et ut", "type": "component", "sourceCollection": "dolore aute", "ref": "ex et est commodo" }, { "path": [ "laboris" ], "type": "folder" }, { "path": [ "ut labore ullamco adipisicing consequat", "cupidatat voluptate dolor fugiat in", "sed quis", "in irure proident nisi non", "cillum nulla" ], "type": "folder" } ], "_id": "34Bf0a26BC47750Ce58EccB0", "version": 1 }, { "name": "test", "gbacRead": [ "fugiat amet ea esse ut" ], "members": [ { "path": "Lorem", "type": "component", "sourceCollection": "labore ut dolor quis aute", "ref": "magna" } ], "_id": "F323837532f26e746A9EE13E", "version": 1 }, { "name": "test", "gbacRead": [ "ex do adipisicing labore occaecat", "Lorem est ut ea incididunt", "voluptate exercitation ad deserunt", "laborum" ], "members": [ { "path": "in cillum enim", "type": "component", "sourceCollection": "sit ullamco ad", "ref": "sunt in in" }, { "path": [ "irure ullamco et ipsum", "proident ut elit", "in esse", "veniam" ], "type": "folder" } ], "_id": "4c903Dda446FDeBbfF5dBEF0", "version": 1 }, { "name": "test", "gbacRead": [ "velit", "velit ad", "veniam non eiusmod dolor commodo", "ea culpa dolore aliqua cillum" ], "members": [ { "path": "minim veniam proident", "type": "component", "sourceCollection": "amet", "ref": "et laboris voluptate" }, { "path": [ "sint qui dolore non", "mollit voluptate", "est proident", "sint sed consectetur eu" ], "type": "folder" }, { "path": "Excepteur in dolore", "type": "component", "sourceCollection": "nostrud amet dolor pariatur", "ref": "dolor qui mollit" }, { "path": "magna nisi culpa dolore", "type": "component", "sourceCollection": "aute elit", "ref": "dolore" } ], "_id": "0010810d85b13A7c0f398df5", "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": "ut dolor tempor anim dolore", "original": { "name": "test", "gbacRead": [ "aute", "officia Excepteur dolore nostrud non", "irure ex esse dolore", "dolore in", "nulla" ], "members": [ { "path": [ "dolore est", "minim velit nostrud", "veniam consectetur", "qui commodo officia id eiusmod", "velit" ], "type": "folder" } ], "_id": "24a09Dbb3eCfCD38871AC83e", "version": 1 }, "created": null, "edit": null, "success": true }, { "message": "ea", "original": { "name": "test", "gbacRead": [ "laboris aliquip pariatur velit" ], "members": [ { "path": "eu", "type": "component", "sourceCollection": "exercitation", "ref": "et qui" } ], "_id": "91E6C0277ad00fBc7cA1Dadb", "version": 1 }, "created": null, "edit": "ipsum aute reprehenderit ut id", "success": true }, { "message": "ea reprehenderit", "original": { "name": "test", "gbacRead": [ "exercitation dolore dolor officia", "sed laboris", "voluptate aliqua amet deserunt in", "et tempor consectetur nostrud", "ea" ], "members": [ { "path": "cillum nulla est esse", "type": "component", "sourceCollection": "non voluptate laboris esse", "ref": "nulla tempor et labore" } ], "_id": "31eaE3F9B1Dcbfda1EF5B42A", "version": 1 }, "created": { "name": "test", "gbacRead": [ "reprehenderit commodo occaecat", "dolor magna" ], "members": [ { "path": "id sunt", "type": "component", "sourceCollection": "veniam esse ut", "ref": "adipisicing dolore ad" } ], "_id": "Fca6beBc76ffa911432A0A72", "description": "dolore", "gbacWrite": [ "velit incididunt culpa aliqua", "occaecat ad nulla exercitation non", "reprehenderit non officia dolore eiusmod", "laborum ea" ], "version": 1 }, "edit": "minim in aliqua cillum", "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" ] } } } }