[Index]
Voicemail service context defined by CUCM (optional), CUCxN, and SIP trunk (if CUCM specified)
Model ref.: data/HcsDpVmServiceDAT
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": {
"numberOfPorts": {
"is_password": false,
"description": "Number of voice messaging ports to create on voice mail service (1-250). Voice messaging ports can be configured up to the maximum allowed configuration for the voice mail server.",
"title": "Voice Messaging Ports",
"default": "3",
"pattern": "^([1-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|250)$",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cucSvcMode": {
"is_password": false,
"description": "Indicates whether the voice mail service is dedicated or partitioned.",
"title": "Voice Mail Service Mode",
"default": "Dedicated",
"required": false,
"displayable": false,
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Partitioned",
"title": "Partitioned"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"description": "The name for the voice mail service.",
"title": "Voice Mail Service Name",
"pattern": "^(\\S)+$",
"required": true,
"displayable": false,
"readonly": true,
"maxLength": 20,
"type": "string"
},
"cucm": {
"is_password": false,
"description": "The CUCM device associated with this voice mail service.",
"format": "uri",
"title": "CUCM Device",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "host",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/CallManager",
"type": "string",
"target": "/api/data/CallManager/choices/?field=host&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"isWebexDI": {
"is_password": false,
"description": "Integrate with Cisco Unified CM Webex Dedicated Instance.",
"title": "Integrate with Cisco Unified CM Webex DI",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"vmCucmSipTrunk": {
"is_password": false,
"description": "VM CUCM SIP Trunk.",
"title": "Voice Mail Trunk Address",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"vmServicePort": {
"is_password": false,
"description": "The port of the voice mail service (1-65535).",
"title": "Voice Mail Trunk Port",
"pattern": "^(?:6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{1,3}|[1-9])$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cucmServiceAddr": {
"is_password": false,
"description": "The remote hostname or IP address for the voice mail service trunk.",
"title": "Remote Trunk Address",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cuc": {
"is_password": false,
"target": "/api/data/UnityConnection/choices/?field=host&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Voice Mail Server Device",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "host",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/UnityConnection",
"type": "string"
},
"cucmClusterName": {
"is_password": false,
"description": "The CUCM cluster that is associated with this voice mail service.",
"format": "uri",
"title": "CUCM Cluster",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "bkCUCMCluster_name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "device/hcmf/CUCM",
"type": "string",
"target": "/api/device/hcmf/CUCM/choices/?field=bkCUCMCluster_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"vmServiceAddr": {
"is_password": false,
"description": "The hostname or IP address of the voice mail service.",
"title": "Voice Mail Trunk Address",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"isCucmPresent": {
"is_password": false,
"description": "Enable if there is a CUCM associated with the Voice Mail Cluster for this voice mail service.",
"title": "Integrate with CUCM",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"cucmServicePort": {
"is_password": false,
"description": "The remote port for voice mail service trunk (1-65535).",
"title": "Remote Trunk Port",
"pattern": "^(?:6553[0-5]|655[0-2][0-9]|65[0-4][0-9]{2}|6[0-4][0-9]{3}|[1-5][0-9]{4}|[1-9][0-9]{1,3}|[1-9])$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"cucClusterName": {
"is_password": false,
"target": "/api/device/hcmf/CUCxn/choices/?field=bkCUCxnCluster_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Voice Mail Cluster",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "bkCUCxnCluster_name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "device/hcmf/CUCxn",
"type": "string"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsDpVmServiceDAT/add/ |
|
The GUI Add form of data/HcsDpVmServiceDAT 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/data/HcsDpVmServiceDAT | 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/data/HcsDpVmServiceDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsDpVmServiceDAT/[pkid1]", "/api/data/HcsDpVmServiceDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsDpVmServiceDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsDpVmServiceDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsDpVmServiceDAT/export/ |
|
{ "hrefs":["/api/data/HcsDpVmServiceDAT/[pkid1]", "/api/data/HcsDpVmServiceDAT/[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 data/HcsDpVmServiceDAT and the JSON format can be used to import instances of data/HcsDpVmServiceDAT.
GET http://[host-proxy]/api/data/HcsDpVmServiceDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsDpVmServiceDAT | POST | /api/data/HcsDpVmServiceDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsDpVmServiceDAT/ |
|
The data/HcsDpVmServiceDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsDpVmServiceDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsDpVmServiceDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/HcsDpVmServiceDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDpVmServiceDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDpVmServiceDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsDpVmServiceDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsDpVmServiceDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDpVmServiceDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDpVmServiceDAT",
"model_specific_actions": [
"get",
"list",
"add",
"update",
"remove",
"help",
"import",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Voice Mail Service Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3aeb2ace894e001206ba1c",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "2.1",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3aeb2ace894e001206ba1c",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/"
}
],
"parent": [
{
"pkid": "5f3ae256ce894e001204f7db",
"href": "/api/data/HierarchyNode/5f3ae256ce894e001204f7db"
}
],
"foreign_key": [
{
"pkid": "5f3ae59cce894e00120554b1",
"path": "cuc",
"model_type": "data/UnityConnection"
},
{
"pkid": "5f3ae58ace894e00120550c2",
"path": "cucm",
"model_type": "data/CallManager"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDpVmServiceDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3aeb2ace894e001206ba1c"
],
"summary_attrs": [
{
"name": "name",
"title": "Voice Mail Service Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numberOfPorts": "3",
"cucSvcMode": "Dedicated",
"name": "ABG-VMS-1",
"pkid": "5f3aeb2ace894e001206ba1f",
"cucm": "192.168.100.15",
"cuc": "192.168.100.20",
"vmServicePort": "5072",
"cucmServiceAddr": "192.168.100.15",
"isCucmPresent": true,
"vmServiceAddr": "192.168.100.20",
"cucmClusterName": "ABG-CL1",
"cucmServicePort": "5072",
"hierarchy_friendly_name": "CS-AB (Reseller)",
"cucClusterName": "ABG-CUCXN1",
"hierarchy_path": "sys.hcs.CS-P.CS-AB"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3aeb2ace894e001206ba1c",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"name"
]
},
"schema_version": "2.1",
"references": {
"parent": [
{
"pkid": "5f3ae256ce894e001204f7db",
"href": "/api/data/HierarchyNode/5f3ae256ce894e001204f7db"
}
],
"self": [
{
"pkid": "5f3aeb2ace894e001206ba1c",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/"
}
],
"foreign_key": [
{
"pkid": "5f3ae59cce894e00120554b1",
"path": "cuc",
"model_type": "data/UnityConnection"
},
{
"pkid": "5f3ae58ace894e00120550c2",
"path": "cucm",
"model_type": "data/CallManager"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsDpVmServiceDAT/5f3aeb2ace894e001206ba1c/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsDpVmServiceDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3aeb2ace894e001206ba1c"
],
"summary_attrs": [
{
"name": "name",
"title": "Voice Mail Service Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"numberOfPorts": "3",
"cucSvcMode": "Dedicated",
"name": "ABG-VMS-1",
"pkid": "5f3aeb2ace894e001206ba1f",
"cucm": "192.168.100.15",
"cuc": "192.168.100.20",
"vmServicePort": "5072",
"cucmServiceAddr": "192.168.100.15",
"isCucmPresent": true,
"vmServiceAddr": "192.168.100.20",
"cucmClusterName": "ABG-CL1",
"cucmServicePort": "5072",
"cucClusterName": "ABG-CUCXN1"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsDpVmServiceDAT. | GET | /api/data/HcsDpVmServiceDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsDpVmServiceDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsDpVmServiceDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsDpVmServiceDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsDpVmServiceDAT/[pkid]/import | 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 data/HcsDpVmServiceDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsDpVmServiceDAT/[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 data/HcsDpVmServiceDAT and the JSON format can be used to import instances of data/HcsDpVmServiceDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsDpVmServiceDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsDpVmServiceDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsDpVmServiceDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsDpVmServiceDAT. |