[Index]
Model ref.: device/cucm/RemoteDestinationProfile
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": {
"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"
},
"networkHoldMohAudioSourceId": {
"description": " Choose the audio source from the IOS gateway that provides multicasting audio source for Cisco Unified Mobility and Mobile Voice Access calls. ",
"format": "uri",
"minItems": 0,
"title": "Network Hold MOH Audio Source",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"userId": {
"description": " Choose the user to whom this profile is assigned. The selection must match the ID of a user in the End User Configuration window where Enable Mobility is checked. ",
"format": "uri",
"minItems": 1,
"title": "User ID",
"required": true,
"choices": [],
"target_attr": "userid",
"maxItems": 1,
"target_model_type": "device/cucm/User",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"userHoldMohAudioSourceId": {
"description": " Choose the audio option for users on hold for Cisco Unified Mobility and Mobile Voice Access calls. ",
"format": "uri",
"minItems": 0,
"title": "User Hold Audio Source",
"required": false,
"choices": [],
"target_attr": "sourceId",
"maxItems": 1,
"target_model_type": "device/cucm/MohAudioSource",
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"callingSearchSpaceName": {
"description": " Choose the calling search space to be used for routing Mobile Voice Access or Enterprise Feature Access calls. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This calling search space setting applies only when you are routing calls from the remote destination, which specifies the outbound call leg to the dialed number for Mobile Voice Access and Enterprise Feature Access calls. \n \n \n ",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"mobileSmartClientProfileName": {
"target": "/api/device/cucm/MobileSmartClientProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/MobileSmartClientProfile",
"title": "Mobile Smart Client Profile Name",
"type": [
"string",
"null"
]
},
"networkLocale": {
"target": "/api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"title": "Network Locale",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Country",
"type": [
"string",
"null"
]
},
"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 Remote Destination Profile 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"
},
"description": {
"description": " Enter a text description of the remote destination profile. This field can comprise up to 128 characters. You can use all characters except quotes (\u201c), close angle bracket (>), open angle bracket (<), backslash (\\), ampersand (&), and percent sign (%). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"ignorePresentationIndicators": {
"description": " Check the check box if you want to ignore the connected line ID presentation. Use this configuration for internal calls. ",
"title": "Ignore Presentation Indicators (internal calls only)",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"userLocale": {
"description": " From the drop-down list box, choose the locale that is associated with the phone user interface. The user locale identifies a set of detailed information, including language and font, to support users. \n Cisco Unified Communications Manager makes this field available only for phone models that support localization. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If the users require information to display (on the phone) in any language other than English, verify that the locale installer is installed before you configure user locale. See the \n Cisco Unified Communications Manager Locale Installer documentation. \n \n \n ",
"format": "uri",
"minItems": 0,
"title": "User Locale",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/UserLocale",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/UserLocale/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"
},
"primaryPhoneName": {
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Phone",
"title": "Primary Phone Name",
"type": [
"string",
"null"
]
},
"dndOption": {
"description": " This Call Reject option specifies that no incoming call information gets presented to the user. \n \n \n \n Note\u00a0\u00a0\u00a0 \n For mobile devices, dual-mode phones, and phones that are running SCCP, you can only choose the Call Reject option. When you activate DND Call Reject on a mobile device or dual-mode phone, no call information gets presented to the device. \n \n \n ",
"title": "Dnd Option",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Ringer Off",
"title": "Ringer Off"
},
{
"value": "Call Reject",
"title": "Call Reject"
},
{
"value": "Use Common Phone Profile Setting",
"title": "Use Common Phone Profile Setting"
}
],
"default": "Ringer Off",
"maxItems": 1,
"type": "string"
},
"dndStatus": {
"description": " Check this check box to enable Do Not Disturb on the phone. ",
"title": "Dnd Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"name": {
"description": " Enter a text name for the remote destination profile. This name can comprise up to 50 characters. Valid characters include letters, numbers, dashes, dots (periods), spaces, and underscores. ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"callInfoPrivacyStatus": {
"description": " Choose a privacy option for the remote destination profile. If you choose the Default value for this field, the setting matches the value of the Privacy Setting service parameter. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you change and save the value of the Privacy Setting service parameter, you must return to the Remote Destination Profile Configuration window for a remote destination profile that specifies Default and click Save for the service parameter change to take effect. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n You cannot transfer a call from a cell phone to a desk phone if the Remote Destination Profile Privacy specifies On, and the \"Enforce Privacy Setting on Held Calls\" service parameter specifies True. \n \n \n ",
"title": "Privacy",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"rerouteCallingSearchSpaceName": {
"description": " Choose a calling search space to be used to route Cisco Unified Mobility calls. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. \n Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with \n Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise. \n \n \n ",
"format": "uri",
"minItems": 0,
"title": "Rerouting Calling Search Space",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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,
"title": "User Id",
"required": true,
"choices": [],
"target_attr": "userid",
"maxItems": 1,
"target_model_type": "device/cucm/User",
"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",
"null"
]
},
"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": {
"line_filter": {
"name": "line_filter",
"title": "Inventory Filter",
"default": "default",
"required": false,
"choices": [
{
"value": "default",
"title": "Default"
},
{
"value": "lines_e164_unused_local",
"title": "Show Unused Numbers with Associated E164's (Site Only)"
},
{
"value": "lines_e164_unused",
"title": "Show Unused Numbers with Associated E164's"
},
{
"value": "lines_used_only_local",
"title": "Show Used Numbers (Site Only)"
},
{
"value": "lines_used_only",
"title": "Show Used Numbers"
},
{
"value": "lines_userid_used",
"title": "Show Numbers belonging to this Subscriber"
}
],
"type": "string"
},
"pattern": {
"name": "pattern",
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"name": "routePartitionName",
"format": "uri",
"minItems": 1,
"title": "Route Partition Name",
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"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"
}
}
},
"cgpnTransformationCssName": {
"description": " Choose the calling search space for transformations. 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 Note\u00a0\u00a0\u00a0 \n The partitions in the calling search space should contain only calling party transformations. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure the calling search space is not null because no transformations can apply to null partitions. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The device takes on the attributes of the Calling Party Transformation Pattern because you assign the pattern to a partition where the Calling Party Transformation CSS exists. For example, when you configure the Calling Party Transformation CSS under Call Routing\u00a0> Class of Control\u00a0> Calling Search Space, you assign the CSS to a partition; when you configure the Calling Party Transformation CSS under Call Routing\u00a0> Transformation Pattern\u00a0> Calling Party Transformation Pattern, you choose the partition where the Calling Party Transformation CSS is assigned. \n \n \n ",
"format": "uri",
"minItems": 0,
"title": "Calling Party Transformation CSS",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"automatedAlternateRoutingCssName": {
"description": " Choose a calling search space to be used to route Cisco Unified Mobility calls. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the gateway that is configured for routing mobile calls is assigned to the partition that belongs to the Rerouting Calling Search Space. \n Cisco Unified Communications Manager determines how to route calls based on the remote destination number and the Rerouting Calling Search Space. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Rerouting Calling Search Space setting applies only when you are routing calls to the remote destination or mobility identity, which specifies the outbound call leg toward the remote destination or mobility identity when a call comes in to the user enterprise number. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Cisco Unified Mobility calls do not get routed to the dual-mode mobility identity number that corresponds to the dual-mode mobile phone number if the device associates with the enterprise WLAN and registers with \n Cisco Unified Communications Manager. Cisco Unified Mobility calls get routed to the dual-mode mobility identity number only when the device is outside the enterprise. \n \n \n ",
"format": "uri",
"minItems": 0,
"title": "Calling Search Space AAR",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/Css",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"devicePoolName": {
"description": " Choose the device pool that applies to this profile. The device pool defines sets of common characteristics for devices, such as region, date/time group, softkey template, and MLPP information. ",
"format": "uri",
"minItems": 1,
"title": "Device Pool",
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/DevicePool",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/RemoteDestinationProfile/add/ |
|
The GUI Add form of device/cucm/RemoteDestinationProfile as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/cucm/RemoteDestinationProfile/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/cucm/RemoteDestinationProfile/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/RemoteDestinationProfile/[pkid1]", "/api/device/cucm/RemoteDestinationProfile/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/RemoteDestinationProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/RemoteDestinationProfile/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/RemoteDestinationProfile/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/RemoteDestinationProfile/[pkid1]", "/api/v0/device/cucm/RemoteDestinationProfile/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/RemoteDestinationProfile/?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/RemoteDestinationProfile |
|
{"hrefs": ["/api/device/cucm/RemoteDestinationProfile/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/RemoteDestinationProfile |
|
{"hrefs": ["/api/device/cucm/RemoteDestinationProfile/[pkid1]", "/api/device/cucm/RemoteDestinationProfile/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/RemoteDestinationProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/RemoteDestinationProfile/export/ |
|
{ "hrefs":["/api/device/cucm/RemoteDestinationProfile/[pkid1]", "/api/device/cucm/RemoteDestinationProfile/[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/RemoteDestinationProfile and the JSON format can be used to import instances of device/cucm/RemoteDestinationProfile.
GET http://[host-proxy]/api/device/cucm/RemoteDestinationProfile/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/RemoteDestinationProfile | POST | /api/device/cucm/RemoteDestinationProfile/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/RemoteDestinationProfile/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/RemoteDestinationProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/RemoteDestinationProfile/ |
|
The device/cucm/RemoteDestinationProfile schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/RemoteDestinationProfile instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"bulk_update_form",
"add",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/RemoteDestinationProfile/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 11
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/device/cucm/RemoteDestinationProfile/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/RemoteDestinationProfile/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/RemoteDestinationProfile/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/RemoteDestinationProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/RemoteDestinationProfile/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/RemoteDestinationProfile/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/RemoteDestinationProfile/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/RemoteDestinationProfile/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/RemoteDestinationProfile/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/RemoteDestinationProfile/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/RemoteDestinationProfile/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/RemoteDestinationProfile",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"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": "5dcd2e104544b7001860b04b",
"meta": {
"tags": [],
"cached": true,
"title": "OscarBuild001-RDP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"self": [
{
"pkid": "5dcd2e104544b7001860b04b",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/"
}
],
"parent": [
{
"pkid": "5dcd32e6e186e30018ebc847",
"href": "/api/data/HierarchyNode/5dcd32e6e186e30018ebc847"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2e104544b7001860b04b/?model_type=device/cucm/RemoteDestinationProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/RemoteDestinationProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd32e6e186e30018ebc847",
"5dcd2e104544b7001860b04b"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"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": "Remote Destination",
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"lines": {
"line": [
{
"index": 1,
"ringSettingActivePickupAlert": null,
"mwlPolicy": "Use System Policy",
"ringSettingIdlePickupAlert": null,
"associatedEndusers": null,
"ringSetting": "Ring",
"recordingFlag": "Call Recording Disabled",
"speedDial": null,
"consecutiveRingSetting": "Use System Default",
"label": null,
"e164Mask": null,
"recordingProfileName": null,
"audibleMwi": "Default",
"missedCallLogging": true,
"recordingMediaSource": "Gateway Preferred",
"callInfoDisplay": {
"dialedNumber": true,
"redirectedNumber": false,
"callerName": true,
"callerNumber": false
},
"maxNumCalls": 2,
"monitoringCssName": null,
"busyTrigger": 1,
"dirn": {
"pattern": "66001001",
"routePartitionName": "OB-PT-001"
},
"partitionUsage": "General"
}
]
},
"userId": "OscarBuild001",
"userHoldMohAudioSourceId": null,
"hierarchy_friendly_name": "Overberg (Site)",
"callingSearchSpaceName": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton.Overberg",
"mobileSmartClientProfileName": null,
"networkLocale": null,
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"useDevicePoolCgpnTransformCss": true,
"product": "Remote Destination Profile",
"description": "Created by default template",
"ignorePresentationIndicators": false,
"userLocale": null,
"class": "Remote Destination Profile",
"primaryPhoneName": null,
"dndOption": "Call Reject",
"dndStatus": false,
"name": "OscarBuild001-RDP",
"callInfoPrivacyStatus": "Default",
"rerouteCallingSearchSpaceName": null,
"protocolSide": "User",
"networkHoldMohAudioSourceId": null,
"cgpnTransformationCssName": null,
"automatedAlternateRoutingCssName": null,
"devicePoolName": "OB-DPOOL-001"
}
},
{
"pkid": "5dcd2e104544b7001860b045",
"meta": {
"tags": [],
"cached": true,
"title": "OscarBuild002-RDP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5dcd2e104544b7001860b045",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/"
}
],
"parent": [
{
"pkid": "5dcd32e6e186e30018ebc847",
"href": "/api/data/HierarchyNode/5dcd32e6e186e30018ebc847"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2e104544b7001860b045/?model_type=device/cucm/RemoteDestinationProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b045/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/RemoteDestinationProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd32e6e186e30018ebc847",
"5dcd2e104544b7001860b045"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"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": "Remote Destination",
"lines": {
"line": [
{
"index": 1,
"ringSettingActivePickupAlert": null,
"mwlPolicy": "Use System Policy",
"ringSettingIdlePickupAlert": null,
"associatedEndusers": null,
"ringSetting": "Ring",
"recordingFlag": "Call Recording Disabled",
"speedDial": null,
"consecutiveRingSetting": "Use System Default",
"label": null,
"e164Mask": null,
"recordingProfileName": null,
"audibleMwi": "Default",
"missedCallLogging": true,
"recordingMediaSource": "Gateway Preferred",
"callInfoDisplay": {
"dialedNumber": true,
"redirectedNumber": false,
"callerName": true,
"callerNumber": false
},
"maxNumCalls": 2,
"monitoringCssName": null,
"busyTrigger": 1,
"dirn": {
"pattern": "66001002",
"routePartitionName": "OB-PT-002"
},
"partitionUsage": "General"
}
]
},
"userId": "OscarBuild002",
"userHoldMohAudioSourceId": null,
"hierarchy_friendly_name": "Overberg (Site)",
"callingSearchSpaceName": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton.Overberg",
"mobileSmartClientProfileName": null,
"networkLocale": null,
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"useDevicePoolCgpnTransformCss": true,
"product": "Remote Destination Profile",
"description": "Created by default template",
"ignorePresentationIndicators": false,
"userLocale": null,
"class": "Remote Destination Profile",
"primaryPhoneName": null,
"dndOption": "Call Reject",
"dndStatus": false,
"name": "OscarBuild002-RDP",
"callInfoPrivacyStatus": "Default",
"rerouteCallingSearchSpaceName": null,
"protocolSide": "User",
"networkHoldMohAudioSourceId": null,
"cgpnTransformationCssName": null,
"automatedAlternateRoutingCssName": null,
"devicePoolName": "OB-DPOOL-002"
}
},
{
"pkid": "5dcd2e114544b7001860b051",
"meta": {
"tags": [],
"cached": true,
"title": "OscarBuild003-RDP",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"self": [
{
"pkid": "5dcd2e114544b7001860b051",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/"
}
],
"parent": [
{
"pkid": "5dcd32e6e186e30018ebc847",
"href": "/api/data/HierarchyNode/5dcd32e6e186e30018ebc847"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2e114544b7001860b051/?model_type=device/cucm/RemoteDestinationProfile",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e114544b7001860b051/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/RemoteDestinationProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd32e6e186e30018ebc847",
"5dcd2e114544b7001860b051"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"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": "Remote Destination",
"hierarchy": "5dcd2d8b9d77dd0018b0ebe6",
"lines": {
"line": [
{
"index": 1,
"ringSettingActivePickupAlert": null,
"mwlPolicy": "Use System Policy",
"ringSettingIdlePickupAlert": null,
"associatedEndusers": null,
"ringSetting": "Ring",
"recordingFlag": "Call Recording Disabled",
"speedDial": null,
"consecutiveRingSetting": "Use System Default",
"label": null,
"e164Mask": null,
"recordingProfileName": null,
"audibleMwi": "Default",
"missedCallLogging": true,
"recordingMediaSource": "Gateway Preferred",
"callInfoDisplay": {
"dialedNumber": true,
"redirectedNumber": false,
"callerName": true,
"callerNumber": false
},
"maxNumCalls": 2,
"monitoringCssName": null,
"busyTrigger": 1,
"dirn": {
"pattern": "66001003",
"routePartitionName": "OB-PT-003"
},
"partitionUsage": "General"
}
]
},
"userId": "OscarBuild003",
"userHoldMohAudioSourceId": null,
"hierarchy_friendly_name": "Overberg (Site)",
"callingSearchSpaceName": null,
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton.Overberg",
"mobileSmartClientProfileName": null,
"networkLocale": null,
"summary_device": "Dedicated CUCM, 10.120.9.245, 8443, hcs.CS-P.CS-NB.Overton",
"useDevicePoolCgpnTransformCss": true,
"product": "Remote Destination Profile",
"description": "Created by default template",
"ignorePresentationIndicators": false,
"userLocale": null,
"class": "Remote Destination Profile",
"primaryPhoneName": null,
"dndOption": "Call Reject",
"dndStatus": false,
"name": "OscarBuild003-RDP",
"callInfoPrivacyStatus": "Default",
"rerouteCallingSearchSpaceName": null,
"protocolSide": "User",
"networkHoldMohAudioSourceId": null,
"cgpnTransformationCssName": null,
"automatedAlternateRoutingCssName": null,
"devicePoolName": "OB-DPOOL-003"
}
}
]
}
(Show the first instance)
{
"pkid": "5dcd2e104544b7001860b04b",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "OscarBuild001-RDP",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5dcd32e6e186e30018ebc847",
"href": "/api/data/HierarchyNode/5dcd32e6e186e30018ebc847"
}
],
"self": [
{
"pkid": "5dcd2e104544b7001860b04b",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5dcd2da2e186e30018ebc0ff",
"href": "/api/v0/data/CallManager/5dcd2da2e186e30018ebc0ff"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5dcd2e104544b7001860b04b/?hierarchy=[hierarchy]&model_type=device/cucm/RemoteDestinationProfile",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/RemoteDestinationProfile/5dcd2e104544b7001860b04b/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/RemoteDestinationProfile",
"path": [
"6t0ggef2c0deab00hb595101",
"5dcc7ff74544b7001862482f",
"5dcd17c256b5de00189138f9",
"5dcd180233fc9b00189005b2",
"5dcd2d8b9d77dd0018b0ebe6",
"5dcd32e6e186e30018ebc847",
"5dcd2e104544b7001860b04b"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "devicePoolName",
"title": "Device Pool"
},
{
"name": "callingSearchSpaceName",
"title": "Calling Search Space"
},
{
"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": "Remote Destination",
"networkHoldMohAudioSourceId": null,
"userId": "OscarBuild001",
"userHoldMohAudioSourceId": null,
"callingSearchSpaceName": null,
"mobileSmartClientProfileName": null,
"networkLocale": null,
"useDevicePoolCgpnTransformCss": true,
"product": "Remote Destination Profile",
"description": "Created by default template",
"ignorePresentationIndicators": false,
"userLocale": null,
"class": "Remote Destination Profile",
"primaryPhoneName": null,
"dndOption": "Call Reject",
"dndStatus": false,
"name": "OscarBuild001-RDP",
"callInfoPrivacyStatus": "Default",
"rerouteCallingSearchSpaceName": null,
"protocolSide": "User",
"lines": {
"line": [
{
"index": 1,
"ringSettingActivePickupAlert": null,
"mwlPolicy": "Use System Policy",
"ringSettingIdlePickupAlert": null,
"associatedEndusers": null,
"e164Mask": null,
"ringSetting": "Ring",
"recordingFlag": "Call Recording Disabled",
"speedDial": null,
"consecutiveRingSetting": "Use System Default",
"label": null,
"maxNumCalls": 2,
"recordingProfileName": null,
"missedCallLogging": true,
"recordingMediaSource": "Gateway Preferred",
"callInfoDisplay": {
"dialedNumber": true,
"redirectedNumber": false,
"callerNumber": false,
"callerName": true
},
"dirn": {
"pattern": "66001001",
"routePartitionName": "OB-PT-001"
},
"audibleMwi": "Default",
"monitoringCssName": null,
"busyTrigger": 1,
"partitionUsage": "General"
}
]
},
"cgpnTransformationCssName": null,
"automatedAlternateRoutingCssName": null,
"devicePoolName": "OB-DPOOL-001"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/RemoteDestinationProfile. | GET | /api/device/cucm/RemoteDestinationProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/RemoteDestinationProfile as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/RemoteDestinationProfile/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/cucm/RemoteDestinationProfile/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/RemoteDestinationProfile/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/RemoteDestinationProfile/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/RemoteDestinationProfile | 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/RemoteDestinationProfile; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/RemoteDestinationProfile/[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/RemoteDestinationProfile and the JSON format can be used to import instances of device/cucm/RemoteDestinationProfile.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/RemoteDestinationProfile/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/RemoteDestinationProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/RemoteDestinationProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/RemoteDestinationProfile. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/RemoteDestinationProfile/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |