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