[Index]
Model ref.: device/cucm/MohServer
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": {
"isMultiCastEnabled": {
"description": "If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766.",
"title": "Is Multi Cast Enabled",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"maxMulticastConnections": {
"description": "Maximum Multicast Connections must be a number in the range 0 to 999999.",
"title": "Max Multicast Connections",
"minItems": 0,
"required": false,
"default": 250000,
"maxItems": 1,
"type": "integer"
},
"name": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Name"
},
"useTrustedRelayPoint": {
"title": "Use Trusted Relay Point",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"devicePoolName": {
"minItems": 1,
"required": true,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Device Pool Name"
},
"multicastIncrementOnIp": {
"description": "If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.",
"title": "Multicast Increment On Ip",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"locationName": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Location Name"
},
"fixedAudioSourceDevice": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Fixed Audio Source Device"
},
"maxUnicastConnections": {
"description": "Maximum Half Duplex Streams must be a number in the range 0 to 500. ",
"title": "Max Unicast Connections",
"minItems": 0,
"required": false,
"default": 250,
"maxItems": 1,
"type": "integer"
},
"baseMulticastPort": {
"description": "If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766",
"title": "Base Multicast Port",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"audioSources": {
"description": "If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty.",
"title": "Audio Sources",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"audioSource": {
"name": "audioSource",
"title": "Audio Source",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"sourceId": {
"name": "sourceId",
"title": "Source Id",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"maxHops": {
"name": "maxHops",
"title": "Max Hops",
"minItems": 0,
"required": false,
"default": 2,
"maxItems": 1,
"type": "integer"
}
}
},
"required": false,
"type": "array"
}
}
},
"runFlag": {
"title": "Run Flag",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"processNodeName": {
"minItems": 1,
"required": true,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Process Node Name"
},
"baseMulticastIpaddress": {
"description": "If isMultiCastEnabled is false then these elements are not necessary. MOHServer will be added to the database without the values of these tags. ie. The table MOHServerMulticastInfo table will be empty. Multicast Base Port number must be an even number in the range 16384 to 32766. baseMulticastIPAddress and baseMulticastPort must be a unique pair. All Multicast IP Addresses must be in the range 239.1.1.1 to 239.255.255.255",
"title": "Base Multicast Ipaddress",
"minItems": 0,
"required": false,
"default": "239.1.1.1",
"maxItems": 1,
"type": "string"
},
"description": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Description"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/MohServer/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/MohServer/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/MohServer/[pkid1]", "/api/v0/device/cucm/MohServer/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/MohServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/MohServer |
|
{"hrefs": ["/api/device/cucm/MohServer/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/MohServer |
|
{"hrefs": ["/api/device/cucm/MohServer/[pkid1]", "/api/device/cucm/MohServer/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/MohServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/MohServer/export/ |
|
{ "hrefs":["/api/device/cucm/MohServer/[pkid1]", "/api/device/cucm/MohServer/[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/cucm/MohServer and the JSON format can be used to import instances of device/cucm/MohServer.
GET http://[host-proxy]/api/device/cucm/MohServer/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/MohServer | POST | /api/device/cucm/MohServer/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/cucm/MohServer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/MohServer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/MohServer/ |
|
The device/cucm/MohServer schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/MohServer instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"export_bulkload_template",
"move",
"transform",
"export",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/MohServer/?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": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/MohServer/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/cucm/MohServer",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohServer/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/cucm/MohServer/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/MohServer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/MohServer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/MohServer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohServer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohServer/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohServer",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"bulk_update_form",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool 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": "5f3ae5ffce894e00120564dd",
"meta": {
"tags": [],
"cached": true,
"title": "MOH_2",
"business_key": {},
"schema_version": "11.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae5ffce894e00120564dd",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5ffce894e00120564dd/?model_type=device/cucm/MohServer",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohServer",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5ffce894e00120564dd"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool 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": {
"isMultiCastEnabled": false,
"maxMulticastConnections": 250000,
"name": "MOH_2",
"useTrustedRelayPoint": "Default",
"description": "MOH_CUCM",
"baseMulticastPort": 0,
"processNodeName": "CUCM",
"multicastIncrementOnIp": false,
"locationName": "Hub_None",
"fixedAudioSourceDevice": null,
"maxUnicastConnections": 250,
"devicePoolName": "Default",
"audioSources": {
"audioSource": [
{}
]
},
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"runFlag": true,
"baseMulticastIpaddress": "0.0.0.0",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae5ffce894e00120564dd",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "MOH_2",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae5ffce894e00120564dd",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae5ffce894e00120564dd/?hierarchy=[hierarchy]&model_type=device/cucm/MohServer",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/MohServer/5f3ae5ffce894e00120564dd/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/MohServer",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae5ffce894e00120564dd"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool 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": {
"isMultiCastEnabled": false,
"maxMulticastConnections": 250000,
"description": "MOH_CUCM",
"useTrustedRelayPoint": "Default",
"devicePoolName": "Default",
"multicastIncrementOnIp": false,
"locationName": "Hub_None",
"fixedAudioSourceDevice": null,
"maxUnicastConnections": 250,
"baseMulticastPort": 0,
"audioSources": null,
"runFlag": true,
"processNodeName": "CUCM",
"baseMulticastIpaddress": "0.0.0.0",
"name": "MOH_2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/MohServer. | GET | /api/device/cucm/MohServer/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/MohServer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/MohServer/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/MohServer/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/MohServer/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/MohServer | 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/cucm/MohServer; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/MohServer/[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/cucm/MohServer and the JSON format can be used to import instances of device/cucm/MohServer.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/MohServer/[pkid] | hierarchy=[hierarchy] | The device/cucm/MohServer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/MohServer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/MohServer. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/MohServer/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |