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": [ "labore" ], "members": [ { "path": [ "commodo" ], "type": "folder" }, { "path": [ "est fugiat aute sunt exercitation", "ea ut id ex" ], "type": "folder" }, { "path": [ "nostrud anim", "nulla veniam", "nulla sed ea sint quis" ], "type": "folder" } ], "_id": "ca8B2ca9A4878Ab8Bf04d81c", "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": "tempor", "original": { "name": "test", "gbacRead": [ "enim qui dolor aliquip amet", "ut ullamco ex exercitation" ], "members": [ { "path": [ "pariatur dolor dolore", "proident adipisicing cillum" ], "type": "folder" }, { "path": "dolore velit", "type": "component", "sourceCollection": "commodo officia", "ref": "in" }, { "path": [ "est nisi amet" ], "type": "folder" } ], "_id": "cb19481dd7fF4e4cFC5E0d54", "version": 1 }, "created": { "name": "test", "gbacRead": [ "anim dolore", "Lorem non est aliquip", "labore" ], "members": [ { "path": "enim qui sed eu non", "type": "component", "sourceCollection": "quis sed ea", "ref": "incididunt" }, { "path": "id", "type": "component", "sourceCollection": "magna sunt", "ref": "ipsum sint reprehenderit deserunt" }, { "path": [ "sit quis", "Duis", "dolore", "dolore ipsum deserunt sit irure" ], "type": "folder" }, { "path": "nostrud adipisicing officia Duis", "type": "component", "sourceCollection": "quis dolor amet ea", "ref": "Duis" } ], "_id": "0fD8Afc25f5aaCb52C71acC2", "description": "amet sint do", "gbacWrite": [ "id nisi deserunt" ], "version": 1 }, "edit": null, "success": true }, { "message": "exercitation", "original": { "name": "test", "gbacRead": [ "tempor velit dolore", "sunt ex dolor culpa", "tempor qui Ut nisi in", "do ea", "ea ullamco est sint quis" ], "members": [ { "path": [ "aliqua", "incididunt enim cillum tempor", "Duis" ], "type": "folder" }, { "path": "sed", "type": "component", "sourceCollection": "Lorem tempor sit reprehenderit", "ref": "in id" } ], "_id": "bcB0ee50eaAEA0ebdc79FFb3", "version": 1 }, "created": null, "edit": null, "success": false }, { "message": "est Excepteur ea sed veniam", "original": { "name": "test", "gbacRead": [ "mollit nulla ut", "laborum minim commodo", "ipsum proident non" ], "members": [ { "path": [ "do", "do mollit aliqua reprehenderit" ], "type": "folder" } ], "_id": "042aA22CE174D01F2A8D0717", "version": 1 }, "created": { "name": "test", "gbacRead": [ "laboris culpa", "tempor", "laboris laborum quis", "labore Duis", "culpa sunt" ], "members": [ { "path": [ "ullamco veniam ipsum", "voluptate irure anim tempor eiusmod", "dolor officia mollit sed Lorem" ], "type": "folder" } ], "_id": "fb9Cd9CFfDd95f7FA346acbb", "description": "irure sunt", "gbacWrite": [ "id ut", "ut nostrud fugiat cillum" ], "version": 1 }, "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" ] } } } }