[Index]
This relation wraps the device/cucm/CtiRoutePoint element.
Model ref.: relation/HcsCtiRoutePointREL
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": {
"useDevicePoolCgpnTransformCss": {
"description": "To use the Calling Party Transformation CSS that is configured in the device pool that is assigned to this device, check this check box. If you do not check this check box, the device uses the Calling Party Transformation CSS that you configured in the CTI Route Point Configuration window. ",
"title": "Use Device Pool Calling Party Transformation CSS",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"product": {
"description": "Product ID string. read-only except when creating a device.",
"title": "Product",
"minItems": 1,
"required": true,
"choices": [
{
"value": "7914 14-Button Line Expansion Module",
"title": "7914 14-Button Line Expansion Module"
},
{
"value": "7915 12-Button Line Expansion Module",
"title": "7915 12-Button Line Expansion Module"
},
{
"value": "7915 24-Button Line Expansion Module",
"title": "7915 24-Button Line Expansion Module"
},
{
"value": "7916 12-Button Line Expansion Module",
"title": "7916 12-Button Line Expansion Module"
},
{
"value": "7916 24-Button Line Expansion Module",
"title": "7916 24-Button Line Expansion Module"
},
{
"value": "AIM-VOICE-30",
"title": "AIM-VOICE-30"
},
{
"value": "Analog Phone",
"title": "Analog Phone"
},
{
"value": "Annunciator",
"title": "Annunciator"
},
{
"value": "BEKEM 36-Button Line Expansion Module",
"title": "BEKEM 36-Button Line Expansion Module"
},
{
"value": "C881V",
"title": "C881V"
},
{
"value": "C887VA-V",
"title": "C887VA-V"
},
{
"value": "CKEM 36-Button Line Expansion Module",
"title": "CKEM 36-Button Line Expansion Module"
},
{
"value": "CP-8800-Audio 28-Button Key Expansion Module",
"title": "CP-8800-Audio 28-Button Key Expansion Module"
},
{
"value": "CP-8800-Video 28-Button Key Expansion Module",
"title": "CP-8800-Video 28-Button Key Expansion Module"
},
{
"value": "CTI Port",
"title": "CTI Port"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Carrier-integrated Mobile",
"title": "Carrier-integrated Mobile"
},
{
"value": "Cisco IAD2400",
"title": "Cisco IAD2400"
},
{
"value": "Cisco 12 S",
"title": "Cisco 12 S"
},
{
"value": "Cisco 12 SP",
"title": "Cisco 12 SP"
},
{
"value": "Cisco 12 SP+",
"title": "Cisco 12 SP+"
},
{
"value": "Cisco 1751",
"title": "Cisco 1751"
},
{
"value": "Cisco 1760",
"title": "Cisco 1760"
},
{
"value": "Cisco 1861",
"title": "Cisco 1861"
},
{
"value": "Cisco 269X",
"title": "Cisco 269X"
},
{
"value": "Cisco 26XX",
"title": "Cisco 26XX"
},
{
"value": "Cisco 2801",
"title": "Cisco 2801"
},
{
"value": "Cisco 2811",
"title": "Cisco 2811"
},
{
"value": "Cisco 2821",
"title": "Cisco 2821"
},
{
"value": "Cisco 2851",
"title": "Cisco 2851"
},
{
"value": "Cisco 2901",
"title": "Cisco 2901"
},
{
"value": "Cisco 2911",
"title": "Cisco 2911"
},
{
"value": "Cisco 2921",
"title": "Cisco 2921"
},
{
"value": "Cisco 2951",
"title": "Cisco 2951"
},
{
"value": "Cisco 30 SP+",
"title": "Cisco 30 SP+"
},
{
"value": "Cisco 30 VIP",
"title": "Cisco 30 VIP"
},
{
"value": "Cisco 362X",
"title": "Cisco 362X"
},
{
"value": "Cisco 364X",
"title": "Cisco 364X"
},
{
"value": "Cisco 366X",
"title": "Cisco 366X"
},
{
"value": "Cisco 3725",
"title": "Cisco 3725"
},
{
"value": "Cisco 3745",
"title": "Cisco 3745"
},
{
"value": "Cisco 3825",
"title": "Cisco 3825"
},
{
"value": "Cisco 3845",
"title": "Cisco 3845"
},
{
"value": "Cisco 3905",
"title": "Cisco 3905"
},
{
"value": "Cisco 3911",
"title": "Cisco 3911"
},
{
"value": "Cisco 3925",
"title": "Cisco 3925"
},
{
"value": "Cisco 3925E",
"title": "Cisco 3925E"
},
{
"value": "Cisco 3945",
"title": "Cisco 3945"
},
{
"value": "Cisco 3945E",
"title": "Cisco 3945E"
},
{
"value": "Cisco 3951",
"title": "Cisco 3951"
},
{
"value": "Cisco 6901",
"title": "Cisco 6901"
},
{
"value": "Cisco 6911",
"title": "Cisco 6911"
},
{
"value": "Cisco 6921",
"title": "Cisco 6921"
},
{
"value": "Cisco 6941",
"title": "Cisco 6941"
},
{
"value": "Cisco 6945",
"title": "Cisco 6945"
},
{
"value": "Cisco 6961",
"title": "Cisco 6961"
},
{
"value": "Cisco 7811",
"title": "Cisco 7811"
},
{
"value": "Cisco 7821",
"title": "Cisco 7821"
},
{
"value": "Cisco 7832",
"title": "Cisco 7832"
},
{
"value": "Cisco 7841",
"title": "Cisco 7841"
},
{
"value": "Cisco 7861",
"title": "Cisco 7861"
},
{
"value": "Cisco 7902",
"title": "Cisco 7902"
},
{
"value": "Cisco 7905",
"title": "Cisco 7905"
},
{
"value": "Cisco 7906",
"title": "Cisco 7906"
},
{
"value": "Cisco 7910",
"title": "Cisco 7910"
},
{
"value": "Cisco 7911",
"title": "Cisco 7911"
},
{
"value": "Cisco 7912",
"title": "Cisco 7912"
},
{
"value": "Cisco 7920",
"title": "Cisco 7920"
},
{
"value": "Cisco 7921",
"title": "Cisco 7921"
},
{
"value": "Cisco 7925",
"title": "Cisco 7925"
},
{
"value": "Cisco 7926",
"title": "Cisco 7926"
},
{
"value": "Cisco 7931",
"title": "Cisco 7931"
},
{
"value": "Cisco 7935",
"title": "Cisco 7935"
},
{
"value": "Cisco 7936",
"title": "Cisco 7936"
},
{
"value": "Cisco 7937",
"title": "Cisco 7937"
},
{
"value": "Cisco 7940",
"title": "Cisco 7940"
},
{
"value": "Cisco 7941",
"title": "Cisco 7941"
},
{
"value": "Cisco 7941G-GE",
"title": "Cisco 7941G-GE"
},
{
"value": "Cisco 7942",
"title": "Cisco 7942"
},
{
"value": "Cisco 7945",
"title": "Cisco 7945"
},
{
"value": "Cisco 7960",
"title": "Cisco 7960"
},
{
"value": "Cisco 7961",
"title": "Cisco 7961"
},
{
"value": "Cisco 7961G-GE",
"title": "Cisco 7961G-GE"
},
{
"value": "Cisco 7962",
"title": "Cisco 7962"
},
{
"value": "Cisco 7965",
"title": "Cisco 7965"
},
{
"value": "Cisco 7970",
"title": "Cisco 7970"
},
{
"value": "Cisco 7971",
"title": "Cisco 7971"
},
{
"value": "Cisco 7975",
"title": "Cisco 7975"
},
{
"value": "Cisco 7985",
"title": "Cisco 7985"
},
{
"value": "Cisco 881",
"title": "Cisco 881"
},
{
"value": "Cisco 8811",
"title": "Cisco 8811"
},
{
"value": "Cisco 8821",
"title": "Cisco 8821"
},
{
"value": "Cisco 8831",
"title": "Cisco 8831"
},
{
"value": "Cisco 8832",
"title": "Cisco 8832"
},
{
"value": "Cisco 8832NR",
"title": "Cisco 8832NR"
},
{
"value": "Cisco 8841",
"title": "Cisco 8841"
},
{
"value": "Cisco 8845",
"title": "Cisco 8845"
},
{
"value": "Cisco 8851",
"title": "Cisco 8851"
},
{
"value": "Cisco 8851NR",
"title": "Cisco 8851NR"
},
{
"value": "Cisco 8861",
"title": "Cisco 8861"
},
{
"value": "Cisco 8865",
"title": "Cisco 8865"
},
{
"value": "Cisco 8865NR",
"title": "Cisco 8865NR"
},
{
"value": "Cisco 888/887/886",
"title": "Cisco 888/887/886"
},
{
"value": "Cisco 8941",
"title": "Cisco 8941"
},
{
"value": "Cisco 8945",
"title": "Cisco 8945"
},
{
"value": "Cisco 8961",
"title": "Cisco 8961"
},
{
"value": "Cisco 9951",
"title": "Cisco 9951"
},
{
"value": "Cisco 9971",
"title": "Cisco 9971"
},
{
"value": "Cisco ATA 186",
"title": "Cisco ATA 186"
},
{
"value": "Cisco ATA 187",
"title": "Cisco ATA 187"
},
{
"value": "Cisco ATA 190",
"title": "Cisco ATA 190"
},
{
"value": "Cisco ATA 191",
"title": "Cisco ATA 191"
},
{
"value": "Cisco Catalyst 4000 Access Gateway Module",
"title": "Cisco Catalyst 4000 Access Gateway Module"
},
{
"value": "Cisco Catalyst 4224 Voice Gateway Switch",
"title": "Cisco Catalyst 4224 Voice Gateway Switch"
},
{
"value": "Cisco Catalyst 6000 12 port FXO Gateway",
"title": "Cisco Catalyst 6000 12 port FXO Gateway"
},
{
"value": "Cisco Catalyst 6000 24 port FXS Gateway",
"title": "Cisco Catalyst 6000 24 port FXS Gateway"
},
{
"value": "Cisco Catalyst 6000 E1 VoIP Gateway",
"title": "Cisco Catalyst 6000 E1 VoIP Gateway"
},
{
"value": "Cisco Catalyst 6000 T1 VoIP Gateway",
"title": "Cisco Catalyst 6000 T1 VoIP Gateway"
},
{
"value": "Cisco Cius",
"title": "Cisco Cius"
},
{
"value": "Cisco Cius SP",
"title": "Cisco Cius SP"
},
{
"value": "Cisco Collaboration Mobile Convergence",
"title": "Cisco Collaboration Mobile Convergence"
},
{
"value": "Cisco Conference Bridge (WS-SVC-CMM)",
"title": "Cisco Conference Bridge (WS-SVC-CMM)"
},
{
"value": "Cisco Conference Bridge Hardware",
"title": "Cisco Conference Bridge Hardware"
},
{
"value": "Cisco Conference Bridge Software",
"title": "Cisco Conference Bridge Software"
},
{
"value": "Cisco DX650",
"title": "Cisco DX650"
},
{
"value": "Cisco DX70",
"title": "Cisco DX70"
},
{
"value": "Cisco DX80",
"title": "Cisco DX80"
},
{
"value": "Cisco Dual Mode for Android",
"title": "Cisco Dual Mode for Android"
},
{
"value": "Cisco Dual Mode for iPhone",
"title": "Cisco Dual Mode for iPhone"
},
{
"value": "Cisco E20",
"title": "Cisco E20"
},
{
"value": "Cisco ENCS 5400 ISRV",
"title": "Cisco ENCS 5400 ISRV"
},
{
"value": "Cisco IOS Conference Bridge",
"title": "Cisco IOS Conference Bridge"
},
{
"value": "Cisco IOS Enhanced Conference Bridge",
"title": "Cisco IOS Enhanced Conference Bridge"
},
{
"value": "Cisco IOS Enhanced Media Termination Point",
"title": "Cisco IOS Enhanced Media Termination Point"
},
{
"value": "Cisco IOS Enhanced Software Media Termination Point",
"title": "Cisco IOS Enhanced Software Media Termination Point"
},
{
"value": "Cisco IOS Guaranteed Audio Video Conference Bridge",
"title": "Cisco IOS Guaranteed Audio Video Conference Bridge"
},
{
"value": "Cisco IOS Heterogeneous Video Conference Bridge",
"title": "Cisco IOS Heterogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Homogeneous Video Conference Bridge",
"title": "Cisco IOS Homogeneous Video Conference Bridge"
},
{
"value": "Cisco IOS Media Termination Point",
"title": "Cisco IOS Media Termination Point"
},
{
"value": "Cisco IP Communicator",
"title": "Cisco IP Communicator"
},
{
"value": "Cisco ISR 4321",
"title": "Cisco ISR 4321"
},
{
"value": "Cisco ISR 4331",
"title": "Cisco ISR 4331"
},
{
"value": "Cisco ISR 4351",
"title": "Cisco ISR 4351"
},
{
"value": "Cisco ISR 4431",
"title": "Cisco ISR 4431"
},
{
"value": "Cisco ISR 4451",
"title": "Cisco ISR 4451"
},
{
"value": "Cisco ISR 4461",
"title": "Cisco ISR 4461"
},
{
"value": "Cisco Jabber for Tablet",
"title": "Cisco Jabber for Tablet"
},
{
"value": "Cisco MGCP BRI Port",
"title": "Cisco MGCP BRI Port"
},
{
"value": "Cisco MGCP E1 Port",
"title": "Cisco MGCP E1 Port"
},
{
"value": "Cisco MGCP FXO Port",
"title": "Cisco MGCP FXO Port"
},
{
"value": "Cisco MGCP FXS Port",
"title": "Cisco MGCP FXS Port"
},
{
"value": "Cisco MGCP T1 Port",
"title": "Cisco MGCP T1 Port"
},
{
"value": "Cisco Media Server (WS-SVC-CMM-MS)",
"title": "Cisco Media Server (WS-SVC-CMM-MS)"
},
{
"value": "Cisco Media Termination Point (WS-SVC-CMM)",
"title": "Cisco Media Termination Point (WS-SVC-CMM)"
},
{
"value": "Cisco Media Termination Point Hardware",
"title": "Cisco Media Termination Point Hardware"
},
{
"value": "Cisco Media Termination Point Software",
"title": "Cisco Media Termination Point Software"
},
{
"value": "Cisco Meeting Server",
"title": "Cisco Meeting Server"
},
{
"value": "Cisco Spark Remote Device",
"title": "Cisco Spark Remote Device"
},
{
"value": "Cisco TelePresence",
"title": "Cisco TelePresence"
},
{
"value": "Cisco TelePresence 1000",
"title": "Cisco TelePresence 1000"
},
{
"value": "Cisco TelePresence 1100",
"title": "Cisco TelePresence 1100"
},
{
"value": "Cisco TelePresence 1300-47",
"title": "Cisco TelePresence 1300-47"
},
{
"value": "Cisco TelePresence 1300-65",
"title": "Cisco TelePresence 1300-65"
},
{
"value": "Cisco TelePresence 200",
"title": "Cisco TelePresence 200"
},
{
"value": "Cisco TelePresence 3000",
"title": "Cisco TelePresence 3000"
},
{
"value": "Cisco TelePresence 3200",
"title": "Cisco TelePresence 3200"
},
{
"value": "Cisco TelePresence 400",
"title": "Cisco TelePresence 400"
},
{
"value": "Cisco TelePresence 500-32",
"title": "Cisco TelePresence 500-32"
},
{
"value": "Cisco TelePresence 500-37",
"title": "Cisco TelePresence 500-37"
},
{
"value": "Cisco TelePresence Codec C40",
"title": "Cisco TelePresence Codec C40"
},
{
"value": "Cisco TelePresence Codec C60",
"title": "Cisco TelePresence Codec C60"
},
{
"value": "Cisco TelePresence Codec C90",
"title": "Cisco TelePresence Codec C90"
},
{
"value": "Cisco TelePresence Conductor",
"title": "Cisco TelePresence Conductor"
},
{
"value": "Cisco TelePresence DX70",
"title": "Cisco TelePresence DX70"
},
{
"value": "Cisco TelePresence EX60",
"title": "Cisco TelePresence EX60"
},
{
"value": "Cisco TelePresence EX90",
"title": "Cisco TelePresence EX90"
},
{
"value": "Cisco TelePresence Exchange System",
"title": "Cisco TelePresence Exchange System"
},
{
"value": "Cisco TelePresence IX5000",
"title": "Cisco TelePresence IX5000"
},
{
"value": "Cisco TelePresence MCU",
"title": "Cisco TelePresence MCU"
},
{
"value": "Cisco TelePresence MX200",
"title": "Cisco TelePresence MX200"
},
{
"value": "Cisco TelePresence MX200 G2",
"title": "Cisco TelePresence MX200 G2"
},
{
"value": "Cisco TelePresence MX300",
"title": "Cisco TelePresence MX300"
},
{
"value": "Cisco TelePresence MX300 G2",
"title": "Cisco TelePresence MX300 G2"
},
{
"value": "Cisco TelePresence MX700",
"title": "Cisco TelePresence MX700"
},
{
"value": "Cisco TelePresence MX800",
"title": "Cisco TelePresence MX800"
},
{
"value": "Cisco TelePresence MX800 Dual",
"title": "Cisco TelePresence MX800 Dual"
},
{
"value": "Cisco TelePresence Profile 42 (C20)",
"title": "Cisco TelePresence Profile 42 (C20)"
},
{
"value": "Cisco TelePresence Profile 42 (C40)",
"title": "Cisco TelePresence Profile 42 (C40)"
},
{
"value": "Cisco TelePresence Profile 42 (C60)",
"title": "Cisco TelePresence Profile 42 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 (C40)",
"title": "Cisco TelePresence Profile 52 (C40)"
},
{
"value": "Cisco TelePresence Profile 52 (C60)",
"title": "Cisco TelePresence Profile 52 (C60)"
},
{
"value": "Cisco TelePresence Profile 52 Dual (C60)",
"title": "Cisco TelePresence Profile 52 Dual (C60)"
},
{
"value": "Cisco TelePresence Profile 65 (C60)",
"title": "Cisco TelePresence Profile 65 (C60)"
},
{
"value": "Cisco TelePresence Profile 65 Dual (C90)",
"title": "Cisco TelePresence Profile 65 Dual (C90)"
},
{
"value": "Cisco TelePresence Quick Set C20",
"title": "Cisco TelePresence Quick Set C20"
},
{
"value": "Cisco TelePresence SX10",
"title": "Cisco TelePresence SX10"
},
{
"value": "Cisco TelePresence SX20",
"title": "Cisco TelePresence SX20"
},
{
"value": "Cisco TelePresence SX80",
"title": "Cisco TelePresence SX80"
},
{
"value": "Cisco TelePresence TX1310-65",
"title": "Cisco TelePresence TX1310-65"
},
{
"value": "Cisco TelePresence TX9000",
"title": "Cisco TelePresence TX9000"
},
{
"value": "Cisco TelePresence TX9200",
"title": "Cisco TelePresence TX9200"
},
{
"value": "Cisco Unified Client Services Framework",
"title": "Cisco Unified Client Services Framework"
},
{
"value": "Cisco Unified Communications for RTX",
"title": "Cisco Unified Communications for RTX"
},
{
"value": "Cisco Unified Mobile Communicator",
"title": "Cisco Unified Mobile Communicator"
},
{
"value": "Cisco Unified Personal Communicator",
"title": "Cisco Unified Personal Communicator"
},
{
"value": "Cisco VG200",
"title": "Cisco VG200"
},
{
"value": "Cisco VG248 Gateway",
"title": "Cisco VG248 Gateway"
},
{
"value": "Cisco VGC Phone",
"title": "Cisco VGC Phone"
},
{
"value": "Cisco VGC Virtual Phone",
"title": "Cisco VGC Virtual Phone"
},
{
"value": "Cisco VGD-1T3",
"title": "Cisco VGD-1T3"
},
{
"value": "Cisco VXC 6215",
"title": "Cisco VXC 6215"
},
{
"value": "Cisco Video Conference Bridge(IPVC-35xx)",
"title": "Cisco Video Conference Bridge(IPVC-35xx)"
},
{
"value": "Cisco Voice Mail Port",
"title": "Cisco Voice Mail Port"
},
{
"value": "Cisco Webex DX80",
"title": "Cisco Webex DX80"
},
{
"value": "Cisco Webex Room 55",
"title": "Cisco Webex Room 55"
},
{
"value": "Cisco Webex Room 55 Dual",
"title": "Cisco Webex Room 55 Dual"
},
{
"value": "Cisco Webex Room 70 Dual",
"title": "Cisco Webex Room 70 Dual"
},
{
"value": "Cisco Webex Room 70 Dual G2",
"title": "Cisco Webex Room 70 Dual G2"
},
{
"value": "Cisco Webex Room 70 Single",
"title": "Cisco Webex Room 70 Single"
},
{
"value": "Cisco Webex Room 70 Single G2",
"title": "Cisco Webex Room 70 Single G2"
},
{
"value": "Cisco Webex Room Kit",
"title": "Cisco Webex Room Kit"
},
{
"value": "Cisco Webex Room Kit Mini",
"title": "Cisco Webex Room Kit Mini"
},
{
"value": "Cisco Webex Room Kit Plus",
"title": "Cisco Webex Room Kit Plus"
},
{
"value": "Communication Media Module",
"title": "Communication Media Module"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "FLEX_SLOT",
"title": "FLEX_SLOT"
},
{
"value": "Gatekeeper",
"title": "Gatekeeper"
},
{
"value": "Generic Desktop Video Endpoint",
"title": "Generic Desktop Video Endpoint"
},
{
"value": "Generic Multiple Screen Room System",
"title": "Generic Multiple Screen Room System"
},
{
"value": "Generic Single Screen Room System",
"title": "Generic Single Screen Room System"
},
{
"value": "H.225 Trunk (Gatekeeper Controlled)",
"title": "H.225 Trunk (Gatekeeper Controlled)"
},
{
"value": "H.323 Client",
"title": "H.323 Client"
},
{
"value": "H.323 Gateway",
"title": "H.323 Gateway"
},
{
"value": "Hunt List",
"title": "Hunt List"
},
{
"value": "IAD2400_ANALOG",
"title": "IAD2400_ANALOG"
},
{
"value": "IAD2400_DIGITAL",
"title": "IAD2400_DIGITAL"
},
{
"value": "IMS-integrated Mobile (Basic)",
"title": "IMS-integrated Mobile (Basic)"
},
{
"value": "IP-STE",
"title": "IP-STE"
},
{
"value": "ISDN BRI Phone",
"title": "ISDN BRI Phone"
},
{
"value": "Inter-Cluster Trunk (Gatekeeper Controlled)",
"title": "Inter-Cluster Trunk (Gatekeeper Controlled)"
},
{
"value": "Inter-Cluster Trunk (Non-Gatekeeper Controlled)",
"title": "Inter-Cluster Trunk (Non-Gatekeeper Controlled)"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
},
{
"value": "Load Simulator",
"title": "Load Simulator"
},
{
"value": "Motorola CN622",
"title": "Motorola CN622"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "NM-1V",
"title": "NM-1V"
},
{
"value": "NM-2V",
"title": "NM-2V"
},
{
"value": "NM-4VWIC-MBRD",
"title": "NM-4VWIC-MBRD"
},
{
"value": "NM-HD-1V",
"title": "NM-HD-1V"
},
{
"value": "NM-HD-2V",
"title": "NM-HD-2V"
},
{
"value": "NM-HD-2VE",
"title": "NM-HD-2VE"
},
{
"value": "NM-HDA",
"title": "NM-HDA"
},
{
"value": "NM-HDV",
"title": "NM-HDV"
},
{
"value": "NM-HDV2-0PORT",
"title": "NM-HDV2-0PORT"
},
{
"value": "NM-HDV2-1PORT",
"title": "NM-HDV2-1PORT"
},
{
"value": "NM-HDV2-2PORT",
"title": "NM-HDV2-2PORT"
},
{
"value": "Nokia S60",
"title": "Nokia S60"
},
{
"value": "PA-MCX",
"title": "PA-MCX"
},
{
"value": "PA-VXA",
"title": "PA-VXA"
},
{
"value": "PA-VXB",
"title": "PA-VXB"
},
{
"value": "PA-VXC",
"title": "PA-VXC"
},
{
"value": "Pilot",
"title": "Pilot"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "SCCP Device",
"title": "SCCP Device"
},
{
"value": "SCCP gateway virtual phone",
"title": "SCCP gateway virtual phone"
},
{
"value": "SIP Trunk",
"title": "SIP Trunk"
},
{
"value": "SIP WSM Connection",
"title": "SIP WSM Connection"
},
{
"value": "SPA8800",
"title": "SPA8800"
},
{
"value": "Third-party AS-SIP Endpoint",
"title": "Third-party AS-SIP Endpoint"
},
{
"value": "Third-party SIP Device (Advanced)",
"title": "Third-party SIP Device (Advanced)"
},
{
"value": "Third-party SIP Device (Basic)",
"title": "Third-party SIP Device (Basic)"
},
{
"value": "Transnova S3",
"title": "Transnova S3"
},
{
"value": "Universal Device Template",
"title": "Universal Device Template"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "VG202",
"title": "VG202"
},
{
"value": "VG204",
"title": "VG204"
},
{
"value": "VG224",
"title": "VG224"
},
{
"value": "VG310",
"title": "VG310"
},
{
"value": "VG320",
"title": "VG320"
},
{
"value": "VG350",
"title": "VG350"
},
{
"value": "VG400",
"title": "VG400"
},
{
"value": "VG450",
"title": "VG450"
},
{
"value": "VGC Port",
"title": "VGC Port"
},
{
"value": "VIC_SLOT",
"title": "VIC_SLOT"
},
{
"value": "VKEM 36-Button Line Expansion Module",
"title": "VKEM 36-Button Line Expansion Module"
},
{
"value": "VNM-HDA",
"title": "VNM-HDA"
},
{
"value": "VWIC_SLOT",
"title": "VWIC_SLOT"
},
{
"value": "WS-SVC-CMM-MS",
"title": "WS-SVC-CMM-MS"
},
{
"value": "WS-X6600",
"title": "WS-X6600"
}
],
"maxItems": 1,
"type": "string"
},
"protocol": {
"description": "Protocol option is read-only,except when creating a device.",
"title": "Protocol",
"minItems": 1,
"required": true,
"choices": [
{
"value": "SCCP",
"title": "SCCP"
},
{
"value": "Digital Access PRI",
"title": "Digital Access PRI"
},
{
"value": "H.225",
"title": "H.225"
},
{
"value": "Analog Access",
"title": "Analog Access"
},
{
"value": "Digital Access T1",
"title": "Digital Access T1"
},
{
"value": "Route Point",
"title": "Route Point"
},
{
"value": "Unicast Bridge",
"title": "Unicast Bridge"
},
{
"value": "Multicast Point",
"title": "Multicast Point"
},
{
"value": "Inter-Cluster Trunk",
"title": "Inter-Cluster Trunk"
},
{
"value": "RAS",
"title": "RAS"
},
{
"value": "Digital Access BRI",
"title": "Digital Access BRI"
},
{
"value": "SIP",
"title": "SIP"
},
{
"value": "MGCP",
"title": "MGCP"
},
{
"value": "Static SIP Mobile Subscriber",
"title": "Static SIP Mobile Subscriber"
},
{
"value": "SIP Connector",
"title": "SIP Connector"
},
{
"value": "Remote Destination",
"title": "Remote Destination"
},
{
"value": "Mobile Smart Client",
"title": "Mobile Smart Client"
},
{
"value": "Digital Access E1 R2",
"title": "Digital Access E1 R2"
},
{
"value": "CTI Remote Device",
"title": "CTI Remote Device"
},
{
"value": "Protocol Not Specified",
"title": "Protocol Not Specified"
}
],
"maxItems": 1,
"type": "string"
},
"name": {
"description": "Enter unique identifier for this device, from 1 to 15 characters, including alphanumeric, dot, dash, or underscores. ",
"title": "Device Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 128,
"type": "string"
},
"userHoldMohAudioSourceId": {
"description": "To specify the audio source that plays when an application initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, \n Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"title": "User Hold MOH Audio Source",
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"useTrustedRelayPoint": {
"description": "From the drop-down list box, enable or disable whether \n Cisco Unified Communications Manager inserts a trusted relay point (TRP) device with this media endpoint. Choose one of the following values: \n \n \n Default\u2014If you choose this value, the device uses the Use Trusted Relay Point setting from the common device configuration with which this device associates. \n \n Off\u2014Choose this value to disable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. \n \n On\u2014Choose this value to enable the use of a TRP with this device. This setting overrides the Use Trusted Relay Point setting in the common device configuration with which this device associates. \n A Trusted Relay Point (TRP) device designates an MTP or transcoder device that is labeled as Trusted Relay Point. \n Cisco Unified Communications Manager places the TRP closest to the associated endpoint device if more than one resource is needed for the endpoint (for example, a transcoder or RSVPAgent). If both TRP and MTP are required for the endpoint, TRP gets used as the required MTP. See the \n Cisco Unified Communications Manager System Guide for details of call behavior. If both TRP and RSVPAgent are needed for the endpoint, \n Cisco Unified Communications Manager first tries to find an RSVPAgent that can also be used as a TRP. If both TRP and transcoder are needed for the endpoint, \n Cisco Unified Communications Manager first tries to find a transcoder that is also designated as a TRP. See the \n Cisco Unified Communications Manager System Guide for a complete discussion of network virtualization and trusted relay points. ",
"title": "Use Trusted Relay Point",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"protocolSide": {
"description": "Side information is read-only except when creating a device",
"title": "Protocol Side",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Network",
"title": "Network"
},
{
"value": "User",
"title": "User"
}
],
"default": "User",
"maxItems": 1,
"type": "string"
},
"lines": {
"title": "Lines",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"null",
"object"
],
"properties": {
"line": {
"description": "An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the \"dirn\" or \"dirnId\" element.",
"title": "Line",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"displayAscii": {
"name": "displayAscii",
"title": "Display Ascii",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"associatedEndusers": {
"name": "associatedEndusers",
"title": "Associated Endusers",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"enduser": {
"name": "enduser",
"title": "Enduser",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"userId": {
"name": "userId",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "userid",
"maxItems": 1,
"target_model_type": "device/cucm/User",
"title": "User Id",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
},
"required": false,
"array_element_id_field": "userId",
"type": "array"
}
}
},
"ringSetting": {
"name": "ringSetting",
"title": "Ring Setting",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Ring",
"maxItems": 1,
"type": "string"
},
"consecutiveRingSetting": {
"description": "Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.",
"title": "Consecutive Ring Setting",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "consecutiveRingSetting"
},
"recordingProfileName": {
"name": "recordingProfileName",
"title": "Recording Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"ringSettingActivePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Active Pickup Alert",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "ringSettingActivePickupAlert"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"recordingMediaSource": {
"name": "recordingMediaSource",
"title": "Recording Media Source",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Gateway Preferred",
"title": "Gateway Preferred"
},
{
"value": "Phone Preferred",
"title": "Phone Preferred"
}
],
"default": "Gateway Preferred",
"maxItems": 1,
"type": "string"
},
"maxNumCalls": {
"name": "maxNumCalls",
"title": "Max Num Calls",
"minItems": 0,
"required": false,
"default": 2,
"maxItems": 1,
"type": "integer"
},
"partitionUsage": {
"description": "This tag cannot be modified. It can only be specified in the add request.",
"title": "Partition Usage",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Intercom",
"title": "Intercom"
},
{
"value": "Call Control Discovery Learned Pattern",
"title": "Call Control Discovery Learned Pattern"
},
{
"value": "General",
"title": "General"
},
{
"value": "Directory URI",
"title": "Directory URI"
}
],
"default": "General",
"maxItems": 1,
"type": "string",
"name": "partitionUsage"
},
"recordingFlag": {
"name": "recordingFlag",
"title": "Recording Flag",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Call Recording Disabled",
"title": "Call Recording Disabled"
},
{
"value": "Automatic Call Recording Enabled",
"title": "Automatic Call Recording Enabled"
},
{
"value": "Selective Call Recording Enabled",
"title": "Selective Call Recording Enabled"
}
],
"default": "Call Recording Disabled",
"maxItems": 1,
"type": "string"
},
"speedDial": {
"name": "speedDial",
"title": "Speed Dial",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"monitoringCssName": {
"name": "monitoringCssName",
"title": "Monitoring Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"e164Mask": {
"name": "e164Mask",
"title": "E164Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"missedCallLogging": {
"name": "missedCallLogging",
"title": "Missed Call Logging",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"callInfoDisplay": {
"name": "callInfoDisplay",
"title": "Call Info Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"dialedNumber": {
"name": "dialedNumber",
"title": "Dialed Number",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"redirectedNumber": {
"name": "redirectedNumber",
"title": "Redirected Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callerNumber": {
"name": "callerNumber",
"title": "Caller Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callerName": {
"name": "callerName",
"title": "Caller Name",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
}
}
},
"dirn": {
"description": "Only uuid attribute is returned in response",
"title": "Dirn",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pattern": {
"name": "pattern",
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"name": "routePartitionName",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"title": "Route Partition Name",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"name": "dirn"
},
"mwlPolicy": {
"name": "mwlPolicy",
"title": "Mwl Policy",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Policy",
"title": "Use System Policy"
},
{
"value": "Light and Prompt",
"title": "Light and Prompt"
},
{
"value": "Prompt Only",
"title": "Prompt Only"
},
{
"value": "Light Only",
"title": "Light Only"
},
{
"value": "None",
"title": "None"
}
],
"default": "Use System Policy",
"maxItems": 1,
"type": "string"
},
"ringSettingIdlePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Idle Pickup Alert",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Flash Only",
"title": "Flash Only"
},
{
"value": "Ring Once",
"title": "Ring Once"
},
{
"value": "Ring",
"title": "Ring"
},
{
"value": "Beep Only",
"title": "Beep Only"
}
],
"default": "Use System Default",
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "ringSettingIdlePickupAlert"
},
"busyTrigger": {
"name": "busyTrigger",
"title": "Busy Trigger",
"minItems": 0,
"required": false,
"default": 1,
"maxItems": 1,
"type": "integer"
},
"audibleMwi": {
"description": "Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway",
"title": "Audible Mwi",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string",
"name": "audibleMwi"
},
"display": {
"name": "display",
"title": "Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
}
},
"required": false,
"array_element_id_field": "dirn",
"type": "array",
"name": "line"
}
}
},
"userLocale": {
"description": "From the drop-down list box, choose the locale that is associated with the CTI route point. The user locale identifies a set of detailed information to support users, including language and font. \n Cisco Unified Communications Manager makes this field available only for CTI route points that support localization. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If no user locale is specified, \n Cisco Unified Communications Manager uses the user locale that is associated with the device pool. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n If the users require that information be displayed (on the phone) in any language other than English, verify that the locale installer is installed before configuring user locale. See the \n Cisco Unified Communications Manager locale installer that is in the \n Cisco Unified Communications Operating System Administration Guide. \n \n \n ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/UserLocale",
"title": "User Locale",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"callingSearchSpaceName": {
"description": "From the drop-down list box, choose a calling search space. The calling search space specifies the collection of partitions that are searched to determine how a collected (originating) number should be routed. You can configure the number of calling search spaces that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more calling search spaces exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Calling Search Space window, then find and choose a calling search space name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. \n \n \n ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Calling Search Space",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"locationName": {
"description": "Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location. From the drop-down list box, choose the appropriate location for this CTI route point. A location setting of Hub_None means that the locations feature does not keep track of the bandwidth that this CTI route point consumes. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option. For an explanation of location-based CAC across intercluster trunks, see the \n Cisco Unified Communications Manager System Guide. ",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Location",
"title": "Location",
"type": "string",
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"cgpnTransformationCssName": {
"description": "This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing.\n \n \n ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"title": "Calling Party Transformation CSS",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"devicePoolName": {
"description": "Choose the name of a Device Pool. The device pool specifies the collection of properties for this device, including \n Cisco Unified Communications Manager Group, Date/Time Group, Region, and Calling Search Space for auto-registration. ",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/DevicePool",
"title": "Device Pool",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"mediaResourceListName": {
"description": "Choose the appropriate Media Resource Group List. A Media Resource Group List comprises a prioritized grouping of media resource groups. An application chooses the required media resource, such as a Music On Hold server, from the available media resources according to the priority order that is defined in a Media Resource Group List. If you choose <none>, \n Cisco Unified Communications Manager uses the Media Resource Group that is defined in the device pool. For more information, see topics related to media resource management in the \n Cisco Unified Communications Manager System Guide. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/MediaResourceList",
"title": "Media Resource Group List",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/MediaResourceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"geoLocationName": {
"description": "From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that this device does not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option. For an explanation of geolocations, including configuration details, see the \n Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocations, see the \n Cisco Unified Communications Manager Features and Services Guide. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/GeoLocation",
"title": "Geolocation",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/GeoLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"networkHoldMohAudioSourceId": {
"description": "To specify the audio source that plays when the network initiates a hold action, click the drop-down arrow and choose an audio source from the list that displays. If you do not choose an audio source, \n Cisco Unified Communications Manager uses the audio source that is defined in the device pool or the system default if the device pool does not specify an audio source ID. You define audio sources in the Music On Hold Audio Source Configuration window. For access, choose Media Resources > Music On Hold Audio Source. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"title": "Network Hold MOH Audio Source",
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"commonDeviceConfigName": {
"description": "Choose the common device configuration to which you want this CTI route point assigned. The common device configuration includes the attributes (services or features) that are associated with a particular user. Configure common device configurations in the Common Device Configuration window. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/CommonDeviceConfig",
"title": "Common Device Configuration",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/CommonDeviceConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"class": {
"description": "Class ID string. Class information is read-only except when creating a device.",
"title": "Class",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Phone",
"title": "Phone"
},
{
"value": "Gateway",
"title": "Gateway"
},
{
"value": "Conference Bridge",
"title": "Conference Bridge"
},
{
"value": "Media Termination Point",
"title": "Media Termination Point"
},
{
"value": "Route List",
"title": "Route List"
},
{
"value": "Voice Mail",
"title": "Voice Mail"
},
{
"value": "CTI Route Point",
"title": "CTI Route Point"
},
{
"value": "Music On Hold",
"title": "Music On Hold"
},
{
"value": "Simulation",
"title": "Simulation"
},
{
"value": "Pilot",
"title": "Pilot"
},
{
"value": "GateKeeper",
"title": "GateKeeper"
},
{
"value": "Add-on modules",
"title": "Add-on modules"
},
{
"value": "Hidden Phone",
"title": "Hidden Phone"
},
{
"value": "Trunk",
"title": "Trunk"
},
{
"value": "Tone Announcement Player",
"title": "Tone Announcement Player"
},
{
"value": "Remote Destination Profile",
"title": "Remote Destination Profile"
},
{
"value": "EMCC Base Phone Template",
"title": "EMCC Base Phone Template"
},
{
"value": "EMCC Base Phone",
"title": "EMCC Base Phone"
},
{
"value": "Remote Destination Profile Template",
"title": "Remote Destination Profile Template"
},
{
"value": "Gateway Template",
"title": "Gateway Template"
},
{
"value": "UDP Template",
"title": "UDP Template"
},
{
"value": "Phone Template",
"title": "Phone Template"
},
{
"value": "Device Profile",
"title": "Device Profile"
},
{
"value": "Invalid",
"title": "Invalid"
},
{
"value": "Interactive Voice Response",
"title": "Interactive Voice Response"
}
],
"maxItems": 1,
"type": "string"
},
"description": {
"description": "Enter a descriptive name for the CTI route point. The description can include up to 50 characters in any language, but it cannot include double-quotes (\"), percentage sign (%), ampersand (&), back-slash (\\), or angle brackets (<>). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 128,
"type": "string"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsCtiRoutePointREL/add/ |
|
The GUI Add form of relation/HcsCtiRoutePointREL 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/relation/HcsCtiRoutePointREL/ | 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/relation/HcsCtiRoutePointREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsCtiRoutePointREL/[pkid1]", "/api/relation/HcsCtiRoutePointREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsCtiRoutePointREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsCtiRoutePointREL |
|
{"hrefs": ["/api/relation/HcsCtiRoutePointREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsCtiRoutePointREL |
|
{"hrefs": ["/api/relation/HcsCtiRoutePointREL/[pkid1]", "/api/relation/HcsCtiRoutePointREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsCtiRoutePointREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsCtiRoutePointREL/export/ |
|
{ "hrefs":["/api/relation/HcsCtiRoutePointREL/[pkid1]", "/api/relation/HcsCtiRoutePointREL/[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 relation/HcsCtiRoutePointREL and the JSON format can be used to import instances of relation/HcsCtiRoutePointREL.
GET http://[host-proxy]/api/relation/HcsCtiRoutePointREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsCtiRoutePointREL | POST | /api/relation/HcsCtiRoutePointREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsCtiRoutePointREL/ |
|
The relation/HcsCtiRoutePointREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsCtiRoutePointREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsCtiRoutePointREL/?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": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsCtiRoutePointREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsCtiRoutePointREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsCtiRoutePointREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsCtiRoutePointREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsCtiRoutePointREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsCtiRoutePointREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsCtiRoutePointREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsCtiRoutePointREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsCtiRoutePointREL",
"model_specific_actions": [
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Device Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5dcd2dc54544b7001860a6ef",
"meta": {
"tags": [],
"cached": true,
"title": "CTIRP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd2dc54544b7001860a6ef",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/"
}
],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2dc54544b7001860a6ef/?model_type=relation/HcsCtiRoutePointREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/help",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/+apply/",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/+reset/",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsCtiRoutePointREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd2dc54544b7001860a6ef"
],
"summary_attrs": [
{
"name": "name",
"title": "Device Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"protocol": "SCCP",
"networkHoldMohAudioSourceId": null,
"userHoldMohAudioSourceId": null,
"hierarchy_friendly_name": "Overton (Customer)",
"callingSearchSpaceName": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"useTrustedRelayPoint": "Default",
"commonDeviceConfigName": null,
"cgpnTransformationCssName": null,
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"useDevicePoolCgpnTransformCss": true,
"product": "CTI Route Point",
"description": "CTIRP",
"userLocale": null,
"geoLocationName": null,
"class": "CTI Route Point",
"name": "CTIRP",
"protocolSide": "User",
"lines": null,
"locationName": "location-bvsm-19",
"mediaResourceListName": null,
"devicePoolName": "devicepool19"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd2dc54544b7001860a6ef",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "CTIRP",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"self": [
{
"pkid": "5dcd2dc54544b7001860a6ef",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/"
}
],
"children": [],
"parent": [
{
"pkid": "5dcd2d8b9d77dd0018b0ebe6",
"href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2dc54544b7001860a6ef/?hierarchy=[hierarchy]&model_type=relation/HcsCtiRoutePointREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/+apply/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsCtiRoutePointREL/5dcd2dc54544b7001860a6ef/+reset/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsCtiRoutePointREL",
"summary_attrs": [
{
"name": "name",
"title": "Device Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"data": {
"useDevicePoolCgpnTransformCss": true,
"product": "CTI Route Point",
"protocol": "SCCP",
"name": "CTIRP",
"userHoldMohAudioSourceId": null,
"useTrustedRelayPoint": "Default",
"devicePoolName": "devicepool19",
"lines": null,
"userLocale": null,
"class": "CTI Route Point",
"locationName": "location-bvsm-19",
"cgpnTransformationCssName": null,
"shadow": [],
"protocolSide": "User",
"mediaResourceListName": null,
"geoLocationName": null,
"networkHoldMohAudioSourceId": null,
"commonDeviceConfigName": null,
"callingSearchSpaceName": null,
"description": "CTIRP"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsCtiRoutePointREL. | GET | /api/relation/HcsCtiRoutePointREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsCtiRoutePointREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsCtiRoutePointREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsCtiRoutePointREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsCtiRoutePointREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsCtiRoutePointREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsCtiRoutePointREL | 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 relation/HcsCtiRoutePointREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsCtiRoutePointREL/[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 relation/HcsCtiRoutePointREL and the JSON format can be used to import instances of relation/HcsCtiRoutePointREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsCtiRoutePointREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsCtiRoutePointREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsCtiRoutePointREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsCtiRoutePointREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/relation/HcsCtiRoutePointREL/[pkid]/+apply/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/relation/HcsCtiRoutePointREL/[pkid]/+reset/ | hierarchy=[hierarchy] | If payload required: |