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