[Index]
Model ref.: device/cuc/MailboxStore
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "Status": { "description": " Current status of the mailstore. Will usually be OK. Used by CUSA to show admins.", "title": "Status", "minItems": 0, "readonly": true, "type": "integer", "name": "Status" }, "Mounted": { "minItems": 0, "title": "Mounted", "type": "boolean", "description": " A flag indicating whether the mailbox store is mounted.", "name": "Mounted" }, "DisplayName": { "minItems": 0, "title": "Display Name", "type": "string", "description": " A descriptive name for the Message Store.", "name": "DisplayName" }, "TimeAtWhichSizeCalculated": { "readonly": true, "title": "Time At Which Size Calculated", "type": "string", "description": "The date and time when the size was calculated.", "name": "TimeAtWhichSizeCalculated" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a MailboxStore object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "MailboxStoreType": { "description": " The type of mailbox store (e.g., UMSS).", "title": "Mailbox Store Type", "minItems": 0, "readonly": true, "type": "integer", "name": "MailboxStoreType" }, "TotalSizeOfMailbox": { "readonly": true, "title": "Total Size Of Mailbox", "type": "string", "description": "The total size of the voice messages and attachments.", "name": "TotalSizeOfMailbox" }, "DbInstance": { "description": " The name of the dbinstance on which the mailbox store resides.", "title": "Db Instance", "minItems": 0, "readonly": true, "type": "string", "name": "DbInstance" }, "URI": { "name": "URI", "title": "URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MailboxesURI": { "name": "MailboxesURI", "title": "Mailboxes URI", "minItems": 0, "format": "uri", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "Server": { "description": " The name of the server on which the mailbox store resides.", "title": "Server", "minItems": 0, "readonly": true, "type": "string", "name": "Server" }, "Undeletable": { "minItems": 0, "title": "Undeletable", "type": "boolean", "description": " A flag indicating whether this Mailbox Store can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.", "name": "Undeletable" }, "ServiceAlias": { "minItems": 0, "title": "Service Alias", "type": "string", "description": " The unique text name (alias) for a service to use to logon to mailbox store for message retrieval.", "name": "ServiceAlias" }, "RequiredSecurity": { "description": " The method of encryption that Cisco Unity Connection will use on a mailstore connection.", "title": "Required Security", "minItems": 0, "readonly": true, "type": "integer", "name": "RequiredSecurity" }, "ServicePassword": { "minItems": 0, "title": "Service Password", "type": "string", "description": " The password for a service to use to logon to mailbox store for message retrieval.", "name": "ServicePassword" }, "MailDatabase": { "description": " The name of the mailbox database, such as \"UnityMbxDb1.\"", "title": "Mail Database", "minItems": 0, "readonly": true, "type": "string", "name": "MailDatabase" }, "LastError": { "description": " Last error result from a mailbox store maintenance action: create or delete", "title": "Last Error", "minItems": 0, "readonly": true, "type": "integer", "name": "LastError" }, "MailboxURI": { "title": "Mailbox URI", "type": "string", "description": "The URI to fetch the mailboxes.", "name": "MailboxURI" }, "MaxSizeMB": { "minItems": 0, "title": "Max Size MB", "type": "integer", "description": " This is the max size in MB for the mailstore - when exceeded admin receives warnings.", "name": "MaxSizeMB" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/MailboxStore/add/ |
|
The GUI Add form of device/cuc/MailboxStore as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/device/cuc/MailboxStore/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cuc/MailboxStore/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/MailboxStore/[pkid1]", "/api/device/cuc/MailboxStore/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/MailboxStore/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/MailboxStore/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/MailboxStore/[pkid1]", "/api/v0/device/cuc/MailboxStore/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/MailboxStore |
|
{"hrefs": ["/api/device/cuc/MailboxStore/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/MailboxStore |
|
{"hrefs": ["/api/device/cuc/MailboxStore/[pkid1]", "/api/device/cuc/MailboxStore/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/MailboxStore; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/MailboxStore/export/ |
|
{ "hrefs":["/api/device/cuc/MailboxStore/[pkid1]", "/api/device/cuc/MailboxStore/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of device/cuc/MailboxStore and the JSON format can be used to import instances of device/cuc/MailboxStore.
GET http://[host-proxy]/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/MailboxStore | POST | /api/device/cuc/MailboxStore/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/cuc/MailboxStore/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cuc/MailboxStore/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/MailboxStore/ |
|
The device/cuc/MailboxStore schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/MailboxStore instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/MailboxStore/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 4 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "14.0", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/MailboxStore/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/MailboxStore/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/MailboxStore", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/MailboxStore/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/cuc/MailboxStore/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/MailboxStore/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/MailboxStore/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/MailboxStore/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/MailboxStore/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/MailboxStore", "model_specific_actions": [ "add", "list", "update", "get", "remove", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "63054ef1c46e74b4687c70cd", "meta": { "tags": [], "cached": true, "title": "Unity Messaging Database -1", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "63054cbbc46e74b4687bdb03", "href": "/api/v0/data/UnityConnection/63054cbbc46e74b4687bdb03" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "63054ef1c46e74b4687c70cd", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/" } ], "parent": [ { "pkid": "63054bfdc46e74b4687bb868", "href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/63054ef1c46e74b4687c70cd/?model_type=device/cuc/MailboxStore", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/MailboxStore", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054ef1c46e74b4687c70cd" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Status": 0, "LastError": 0, "DisplayName": "Unity Messaging Database -1", "TimeAtWhichSizeCalculated": "2022-08-24 00:01:00.000", "ObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804", "Undeletable": true, "Mounted": true, "DbInstance": "ciscounity", "URI": "/vmrest/mailboxstores/9179c99c-07ed-447a-8b1a-ce25f8aff804", "Server": "cucm", "MailDatabase": "UnityMbxDb1", "RequiredSecurity": 0, "summary_device": "Partitioned CUCxn, 192.168.100.22, 8443, hcs.CS-P", "TotalSizeOfMailbox": "5.0 Kilobytes", "hierarchy_friendly_name": "CS-P (Provider)", "MailboxStoreType": 0, "MailboxURI": "/vmrest/mailboxstores/9179c99c-07ed-447a-8b1a-ce25f8aff804/mailboxes", "MaxSizeMB": 15000, "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "630550adc46e74b4687ced5a", "meta": { "tags": [], "cached": true, "title": "Unity Messaging Database -1", "business_key": {}, "schema_version": "12.5", "summary": "false", "references": { "device": [ { "pkid": "63054d4bc46e74b4687bf9f2", "href": "/api/v0/data/UnityConnection/63054d4bc46e74b4687bf9f2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "630550adc46e74b4687ced5a", "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/" } ], "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/630550adc46e74b4687ced5a/?model_type=device/cuc/MailboxStore", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/MailboxStore/630550adc46e74b4687ced5a/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/MailboxStore", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "630550adc46e74b4687ced5a" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Status": 0, "LastError": 0, "DisplayName": "Unity Messaging Database -1", "TimeAtWhichSizeCalculated": "2022-08-24 07:40:18.000", "ObjectId": "dac05b6e-0c1c-4bc6-bfc8-1d643015690f", "Undeletable": true, "Mounted": true, "DbInstance": "ciscounity", "URI": "/vmrest/mailboxstores/dac05b6e-0c1c-4bc6-bfc8-1d643015690f", "Server": "cucx", "MailDatabase": "UnityMbxDb1", "RequiredSecurity": 0, "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "TotalSizeOfMailbox": "5.0 Kilobytes", "hierarchy_friendly_name": "AAAGlobal (Customer)", "MailboxStoreType": 0, "MailboxURI": "/vmrest/mailboxstores/dac05b6e-0c1c-4bc6-bfc8-1d643015690f/mailboxes", "MaxSizeMB": 15000, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "630551a0c46e74b4687d1b8b", "meta": { "tags": [], "cached": true, "title": "Unity Messaging Database -1", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "63054dd4c46e74b4687c15f9", "href": "/api/v0/data/UnityConnection/63054dd4c46e74b4687c15f9" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "630551a0c46e74b4687d1b8b", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/" } ], "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/630551a0c46e74b4687d1b8b/?model_type=device/cuc/MailboxStore", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/MailboxStore/630551a0c46e74b4687d1b8b/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/MailboxStore", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "630551a0c46e74b4687d1b8b" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Status": 0, "LastError": 0, "DisplayName": "Unity Messaging Database -1", "TimeAtWhichSizeCalculated": "2022-08-24 00:12:35.000", "ObjectId": "dac05b6e-0c1c-4bc6-bfc8-1d643015690f", "Undeletable": true, "Mounted": true, "DbInstance": "ciscounity", "URI": "/vmrest/mailboxstores/dac05b6e-0c1c-4bc6-bfc8-1d643015690f", "Server": "cucx", "MailDatabase": "UnityMbxDb1", "RequiredSecurity": 0, "summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal", "TotalSizeOfMailbox": "5.0 Kilobytes", "hierarchy_friendly_name": "AAAGlobal (Customer)", "MailboxStoreType": 0, "MailboxURI": "/vmrest/mailboxstores/dac05b6e-0c1c-4bc6-bfc8-1d643015690f/mailboxes", "MaxSizeMB": 15000, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "63054ef1c46e74b4687c70cd", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Unity Messaging Database -1", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "63054bfdc46e74b4687bb868", "href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868" } ], "self": [ { "pkid": "63054ef1c46e74b4687c70cd", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/" } ], "foreign_key": [], "device": [ { "pkid": "63054cbbc46e74b4687bdb03", "href": "/api/v0/data/UnityConnection/63054cbbc46e74b4687bdb03" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/63054ef1c46e74b4687c70cd/?hierarchy=[hierarchy]&model_type=device/cuc/MailboxStore", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/MailboxStore/63054ef1c46e74b4687c70cd/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/MailboxStore", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054ef1c46e74b4687c70cd" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Status": 0, "MailboxURI": "/vmrest/mailboxstores/9179c99c-07ed-447a-8b1a-ce25f8aff804/mailboxes", "MailboxStoreType": 0, "DisplayName": "Unity Messaging Database -1", "TimeAtWhichSizeCalculated": "2022-08-24 00:01:00.000", "ObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804", "LastError": 0, "URI": "/vmrest/mailboxstores/9179c99c-07ed-447a-8b1a-ce25f8aff804", "Server": "cucm", "MaxSizeMB": 15000, "RequiredSecurity": 0, "TotalSizeOfMailbox": "5.0 Kilobytes", "MailDatabase": "UnityMbxDb1", "Mounted": true, "Undeletable": true, "DbInstance": "ciscounity" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/MailboxStore. | GET | /api/device/cuc/MailboxStore/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/MailboxStore as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/MailboxStore/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cuc/MailboxStore/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/MailboxStore/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/MailboxStore/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/MailboxStore | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/MailboxStore; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/MailboxStore/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of device/cuc/MailboxStore and the JSON format can be used to import instances of device/cuc/MailboxStore.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/MailboxStore/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/MailboxStore instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/MailboxStore/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/MailboxStore. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/MailboxStore/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |