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": [ "mollit", "adipisicing eu laboris amet officia", "ullamco in", "fugiat nostrud occaecat ipsum culpa", "deserunt" ], "members": [ { "path": "veniam qui nostrud sit", "type": "component", "sourceCollection": "dolore", "ref": "ut id" } ], "_id": "fa1664F5aeCAefE85fbFBAeD", "version": 1 }, { "name": "test", "gbacRead": [ "aute", "incididunt esse Excepteur", "in", "cupidatat officia" ], "members": [ { "path": [ "consectetur aute in", "do commodo sit labore" ], "type": "folder" }, { "path": [ "ut sint in magna id", "laboris", "do veniam sint sunt aliquip" ], "type": "folder" }, { "path": "sed ex reprehenderit eu", "type": "component", "sourceCollection": "velit laboris ullamco", "ref": "nulla in officia ut velit" } ], "_id": "5d5Ff98bCeFc28fD7fAc2aF7", "version": 1 }, { "name": "test", "gbacRead": [ "proident eiusmod" ], "members": [ { "path": [ "culpa commodo qui dolor non", "adipisicing", "esse", "culpa exercitation" ], "type": "folder" }, { "path": [ "esse ut in ex consectetur", "dolore occaecat dolor esse cillum" ], "type": "folder" }, { "path": "nostrud velit deserunt culpa officia", "type": "component", "sourceCollection": "cillum", "ref": "ut veniam consequat dolor" }, { "path": "ad veniam ex do sint", "type": "component", "sourceCollection": "sit aliqua", "ref": "eiusmod" } ], "_id": "fABfEAc9e9e7c101eDF3598d", "version": 1 }, { "name": "test", "gbacRead": [ "adipisicing occaecat nostrud", "qui sunt fugiat Duis ipsum", "laboris", "Duis minim exercitation ut" ], "members": [ { "path": [ "mollit in aliquip dolor", "nulla anim ullamco nostrud sunt", "anim consequat sed ullamco", "pariatur sunt laboris ex dolore" ], "type": "folder" }, { "path": [ "id amet", "reprehenderit nulla eu", "laborum exercitation" ], "type": "folder" } ], "_id": "BFE06d7Ba1D0d0994B2EBcB4", "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": "enim proident", "original": { "name": "test", "gbacRead": [ "sed officia pariatur incididunt", "occaecat Lorem eu" ], "members": [ { "path": "aliquip dolore", "type": "component", "sourceCollection": "id", "ref": "Duis cillum aute" } ], "_id": "AcD3bDcded0e11a22ACBc3eb", "version": 1 }, "created": { "name": "test", "gbacRead": [ "incididunt", "Lorem deserunt Duis", "ut", "amet mollit nisi proident", "in proident elit tempor exercitation" ], "members": [ { "path": "consequat mollit sint culpa occaecat", "type": "component", "sourceCollection": "ex", "ref": "nisi Excepteur dolore adipisicing irure" }, { "path": [ "laborum cupidatat aliqua occaecat sunt", "non cillum occaecat nulla", "velit nulla culpa et", "eiusmod", "velit in ea dolore" ], "type": "folder" } ], "_id": "CD8Af1a80A70ab99375A7dB6", "description": "ullamco ut", "gbacWrite": [ "occaecat cillum dolor ipsum in" ], "version": 1 }, "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" ] } } } }