[Index]
Model ref.: device/cucm/UniversalDeviceTemplate
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": {
"servicesProvisioning": {
"title": "Services Provisioning",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Internal",
"title": "Internal"
},
{
"value": "External URL",
"title": "External URL"
},
{
"value": "Both",
"title": "Both"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"secureInformationUrl": {
"title": "Secure Information Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"loggedIntoHuntGroup": {
"title": "Logged Into Hunt Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"phonePersonalization": {
"title": "Phone Personalization",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "HTTPS Only",
"title": "HTTPS Only"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"keyOrder": {
"title": "Key Order",
"minItems": 0,
"required": false,
"choices": [
{
"value": "RSA Only",
"title": "RSA Only"
},
{
"value": "EC Only",
"title": "EC Only"
},
{
"value": "EC Preferred, RSA Backup",
"title": "EC Preferred, RSA Backup"
}
],
"default": "RSA Only",
"maxItems": 1,
"type": "string"
},
"alwaysUsePrimeLineForVoiceMessage": {
"title": "Always Use Prime Line For Voice Message",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"devicePool": {
"title": "Device Pool",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DevicePool",
"choices": []
},
"mlppPreemption": {
"title": "Mlpp Preemption",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Forceful",
"title": "Forceful"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"mobilityUserId": {
"title": "Mobility User Id",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "userid",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/User/choices/?choices_source=device/cucm/UniversalDeviceTemplate&field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/User",
"choices": []
},
"useTrustedRelayPoint": {
"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"
},
"secureIdleUrl": {
"title": "Secure Idle Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ownerUserId": {
"title": "Owner User Id",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "userid",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/User/choices/?choices_source=device/cucm/UniversalDeviceTemplate&field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/User",
"choices": []
},
"aarCallingSearchSpace": {
"title": "Aar Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"userLocale": {
"title": "User Locale",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/UserLocale"
},
"busyLampFields": {
"title": "Busy Lamp Fields",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"busyLampField": {
"name": "busyLampField",
"title": "Busy Lamp Field",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"blfDest": {
"description": "Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.",
"title": "Blf Dest",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"name": "blfDest"
},
"associatedBlfSdFeatures": {
"name": "associatedBlfSdFeatures",
"title": "Associated Blf Sd Features",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"feature": {
"name": "feature",
"title": "Feature",
"minItems": 0,
"items": {
"type": "string",
"choices": [
{
"value": "Pickup",
"title": "Pickup"
}
]
},
"required": false,
"type": "array"
}
}
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"blfDirn": {
"description": "Either blfDest or the combination of blfDirn and routePartition is to be mentioned in the add/update request, if both are mentioned AXL will read only the blfDest tag and ignore blfDirn and routePartition.",
"title": "Blf Dirn",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": "string",
"name": "blfDirn"
}
}
},
"required": false,
"type": "array"
}
}
},
"deviceMobilityMode": {
"title": "Device Mobility Mode",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"commonPhoneProfile": {
"title": "Common Phone Profile",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/CommonPhoneConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/CommonPhoneConfig",
"choices": []
},
"outboundCallRollover": {
"title": "Outbound Call Rollover",
"minItems": 1,
"required": true,
"choices": [
{
"value": "No Rollover",
"title": "No Rollover"
},
{
"value": "Rollover Within Same DN",
"title": "Rollover Within Same DN"
},
{
"value": "Rollover to any line",
"title": "Rollover to any line"
}
],
"default": "No Rollover",
"maxItems": 1,
"type": "string"
},
"requiredDtmfReception": {
"title": "Required Dtmf Reception",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"geoLocation": {
"title": "Geo Location",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/GeoLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/GeoLocation",
"choices": []
},
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"retryVideoCallAsAudio": {
"title": "Retry Video Call As Audio",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"authenticationMode": {
"title": "Authentication Mode",
"minItems": 1,
"required": true,
"choices": [
{
"value": "By Authentication String",
"title": "By Authentication String"
},
{
"value": "By Null String",
"title": "By Null String"
},
{
"value": "By Existing Certificate (precedence to LSC)",
"title": "By Existing Certificate (precedence to LSC)"
},
{
"value": "By Existing Certificate (precedence to MIC)",
"title": "By Existing Certificate (precedence to MIC)"
}
],
"default": "By Null String",
"maxItems": 1,
"type": "string"
},
"userHoldMohAudioSource": {
"title": "User Hold Moh Audio Source",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "sourceId",
"maxItems": 1,
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/MohAudioSource",
"choices": []
},
"builtInBridge": {
"title": "Built In Bridge",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"aarGroup": {
"title": "Aar Group",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/AarGroup",
"choices": []
},
"protectedDevice": {
"title": "Protected Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"callingPartyTransformationCSSForOutboundCalls": {
"title": "Calling Party Transformation CSS For Outbound Calls",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"keySize": {
"title": "Key Size",
"minItems": 1,
"required": true,
"choices": [
{
"value": "512",
"title": "512"
},
{
"value": "1024",
"title": "1024"
},
{
"value": "2048",
"title": "2048"
},
{
"value": "3072",
"title": "3072"
},
{
"value": "4096",
"title": "4096"
}
],
"default": "2048",
"maxItems": 1,
"type": "string"
},
"authenticationString": {
"title": "Authentication String",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"requireOffPremiseLocation": {
"title": "Require Off Premise Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": {
"title": "Use Device Pool Calling Party Transformation CS Sfor Inbound Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"subscribeCallingSearchSpaceName": {
"title": "Subscribe Calling Search Space Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"secureDirUrl": {
"title": "Secure Dir Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"rfc2833Disabled": {
"title": "Rfc2833Disabled",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"hotlineDevice": {
"title": "Hotline Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"mtpPreferredOriginatingCodec": {
"title": "Mtp Preferred Originating Codec",
"minItems": 1,
"required": true,
"choices": [
{
"value": "711ulaw",
"title": "711ulaw"
},
{
"value": "711alaw",
"title": "711alaw"
},
{
"value": "G729/G729a",
"title": "G729/G729a"
},
{
"value": "G729b/G729ab",
"title": "G729b/G729ab"
}
],
"default": "711ulaw",
"maxItems": 1,
"type": "string"
},
"sipDialRules": {
"title": "Sip Dial Rules",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/SipDialRules/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/SipDialRules",
"choices": []
},
"messages": {
"title": "Messages",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"location": {
"title": "Location",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Location",
"choices": []
},
"secureMessagesUrl": {
"title": "Secure Messages Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"networkHoldMohAudioSource": {
"title": "Network Hold Moh Audio Source",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "sourceId",
"maxItems": 1,
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/MohAudioSource",
"choices": []
},
"blfPresenceGroup": {
"title": "Blf Presence Group",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/PresenceGroup",
"choices": []
},
"secureShellPassword": {
"is_password": true,
"title": "Secure Shell Password",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"dndIncomingCallAlert": {
"title": "Dnd Incoming Call 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"
}
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"sipProfile": {
"title": "Sip Profile",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/SipProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/SipProfile",
"choices": []
},
"services": {
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"service": {
"name": "service",
"title": "Service",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"name": {
"name": "name",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 100,
"type": "string"
},
"url": {
"name": "url",
"title": "Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"serviceNameAscii": {
"name": "serviceNameAscii",
"title": "Service Name Ascii",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"urlButtonIndex": {
"name": "urlButtonIndex",
"title": "Url Button Index",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": "integer"
},
"telecasterServiceName": {
"name": "telecasterServiceName",
"title": "Telecaster Service Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"urlLabel": {
"name": "urlLabel",
"title": "Url Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"deviceSecurityProfile": {
"title": "Device Security Profile",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/PhoneSecurityProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/PhoneSecurityProfile",
"choices": []
},
"privacy": {
"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"
},
"singleButtonBarge": {
"title": "Single Button Barge",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "Barge",
"title": "Barge"
},
{
"value": "CBarge",
"title": "CBarge"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"mlppIndication": {
"title": "Mlpp Indication",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Off",
"maxItems": 1,
"type": "string"
},
"enableExtensionMobility": {
"title": "Enable Extension Mobility",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"softkeyTemplate": {
"title": "Softkey Template",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/SoftKeyTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/SoftKeyTemplate",
"choices": []
},
"mlppDomain": {
"title": "Mlpp Domain",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "domainName",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/MlppDomain/choices/?field=domainName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/MlppDomain",
"choices": []
},
"networkLocale": {
"title": "Network Locale",
"minItems": 0,
"format": "uri",
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Country"
},
"callingSearchSpace": {
"title": "Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"proxyServer": {
"title": "Proxy Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"allowControlOfDeviceFromCti": {
"title": "Allow Control Of Device From Cti",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"joinAcrossLines": {
"title": "Join Across Lines",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"speeddials": {
"title": "Speeddials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"speeddial": {
"name": "speeddial",
"title": "Speeddial",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"dirn": {
"name": "dirn",
"title": "Dirn",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"secureAuthenticationUrl": {
"title": "Secure Authentication Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"unattendedPort": {
"title": "Unattended Port",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"idle": {
"title": "Idle",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureShellUser": {
"title": "Secure Shell User",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"mediaTerminationPointRequired": {
"title": "Media Termination Point Required",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": {
"title": "Use Device Pool Calling Party Transformation CS Sfor Outbound Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"ecKeySize": {
"title": "Ec Key Size",
"minItems": 0,
"required": false,
"choices": [
{
"value": "256",
"title": "256"
},
{
"value": "384",
"title": "384"
},
{
"value": "521",
"title": "521"
}
],
"maxItems": 1,
"type": "string"
},
"phoneButtonTemplate": {
"title": "Phone Button Template",
"minItems": 1,
"required": true,
"choices": [
[
"Universal Device Template Button Layout",
"Universal Device Template Button Layout"
]
],
"maxItems": 1,
"type": [
"string",
"null"
]
},
"blfAudibleAlertSettingPhoneIdle": {
"title": "Blf Audible Alert Setting Phone Idle",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"alwaysUsePrimeLine": {
"title": "Always Use Prime Line",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"blfAudibleAlertSettingPhoneBusy": {
"title": "Blf Audible Alert Setting Phone Busy",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"blfDirectedCallParks": {
"title": "Blf Directed Call Parks",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"blfDirectedCallPark": {
"name": "blfDirectedCallPark",
"title": "Blf Directed Call Park",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"directedCallParkDnAndPartition": {
"name": "directedCallParkDnAndPartition",
"title": "Directed Call Park Dn And Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"dnPattern": {
"name": "dnPattern",
"title": "Dn Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 255,
"type": "string"
}
}
},
"directedCallParkId": {
"description": "Only the uuid attribute is read",
"title": "Directed Call Park Id",
"minItems": 0,
"pattern": "\\{........-....-....-....-............\\}",
"required": false,
"maxItems": 1,
"type": "string",
"name": "directedCallParkId"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"information": {
"title": "Information",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"commonDeviceConfiguration": {
"title": "Common Device Configuration",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/CommonDeviceConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/CommonDeviceConfig",
"choices": []
},
"packetCaptureDuration": {
"title": "Packet Capture Duration",
"minItems": 0,
"required": false,
"default": 0,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"servicesUrl": {
"title": "Services Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"featureControlPolicy": {
"title": "Feature Control Policy",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/FeatureControlPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/FeatureControlPolicy",
"choices": []
},
"mediaResourceGroupList": {
"title": "Media Resource Group List",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/MediaResourceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/MediaResourceList",
"choices": []
},
"idleTimer": {
"title": "Idle Timer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"packetCaptureMode": {
"title": "Packet Capture Mode",
"minItems": 1,
"required": true,
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "Batch Processing Mode",
"title": "Batch Processing Mode"
}
],
"default": "None",
"maxItems": 1,
"type": "string"
},
"deviceDescription": {
"title": "Device Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"doNotDisturb": {
"title": "Do Not Disturb",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"ignorePresentationIndicators": {
"title": "Ignore Presentation Indicators",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"secureServicesUrl": {
"title": "Secure Services Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"certificateOperation": {
"title": "Certificate Operation",
"minItems": 1,
"required": true,
"choices": [
{
"value": "No Pending Operation",
"title": "No Pending Operation"
},
{
"value": "Install/Upgrade",
"title": "Install/Upgrade"
},
{
"value": "Delete",
"title": "Delete"
},
{
"value": "Troubleshoot",
"title": "Troubleshoot"
}
],
"default": "No Pending Operation",
"maxItems": 1,
"type": "string"
},
"dndOption": {
"title": "Dnd Option",
"minItems": 1,
"required": true,
"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"
},
"lines": {
"title": "Lines",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "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": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"maxNumCalls": {
"name": "maxNumCalls",
"title": "Max Num Calls",
"minItems": 0,
"required": false,
"default": 2,
"maxItems": 1,
"type": "integer"
},
"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"
},
"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"
},
"busyTrigger": {
"name": "busyTrigger",
"title": "Busy Trigger",
"minItems": 0,
"required": false,
"default": 1,
"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"
},
"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"
},
"display": {
"name": "display",
"title": "Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"e164Mask": {
"name": "e164Mask",
"title": "E164Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": [
"string",
"null"
]
},
"recordingProfileName": {
"name": "recordingProfileName",
"title": "Recording Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"missedCallLogging": {
"name": "missedCallLogging",
"title": "Missed Call Logging",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"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"
},
"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"
}
}
},
"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"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"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"
},
"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",
"title": "Route Partition Name",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
},
"name": "dirn"
},
"monitoringCssName": {
"name": "monitoringCssName",
"title": "Monitoring Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"required": false,
"type": "array",
"name": "line"
},
"lineIdentifier": {
"description": "The lineIdentifier is a shorthand method that refers to a particular directory number.",
"title": "Line Identifier",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"directoryNumber": {
"name": "directoryNumber",
"title": "Directory Number",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
}
}
},
"required": false,
"type": "array",
"name": "lineIdentifier"
}
}
},
"reroutingCallingSearchSpace": {
"title": "Rerouting Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"remoteDevice": {
"title": "Remote Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"directory": {
"title": "Directory",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"authenticationServer": {
"title": "Authentication Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callingPartyTransformationCSSForInboundCalls": {
"title": "Calling Party Transformation CSS For Inbound Calls",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/UniversalDeviceTemplate/add/ |
|
The GUI Add form of device/cucm/UniversalDeviceTemplate 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/UniversalDeviceTemplate | 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/UniversalDeviceTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/UniversalDeviceTemplate/[pkid1]", "/api/device/cucm/UniversalDeviceTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/UniversalDeviceTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/UniversalDeviceTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/UniversalDeviceTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/UniversalDeviceTemplate/[pkid1]", "/api/v0/device/cucm/UniversalDeviceTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/UniversalDeviceTemplate/?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/UniversalDeviceTemplate |
|
{"hrefs": ["/api/device/cucm/UniversalDeviceTemplate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/UniversalDeviceTemplate |
|
{"hrefs": ["/api/device/cucm/UniversalDeviceTemplate/[pkid1]", "/api/device/cucm/UniversalDeviceTemplate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/UniversalDeviceTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/UniversalDeviceTemplate/export/ |
|
{ "hrefs":["/api/device/cucm/UniversalDeviceTemplate/[pkid1]", "/api/device/cucm/UniversalDeviceTemplate/[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/UniversalDeviceTemplate and the JSON format can be used to import instances of device/cucm/UniversalDeviceTemplate.
GET http://[host-proxy]/api/device/cucm/UniversalDeviceTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/UniversalDeviceTemplate | POST | /api/device/cucm/UniversalDeviceTemplate/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/UniversalDeviceTemplate/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/UniversalDeviceTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/UniversalDeviceTemplate/ |
|
The device/cucm/UniversalDeviceTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/UniversalDeviceTemplate instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 4,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/device/cucm/UniversalDeviceTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"update",
"field_display_policy",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update_form",
"transform",
"clone",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "device/cucm/UniversalDeviceTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "deviceDescription",
"title": "Device Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update_form",
"clone",
"export_bulkload_template",
"move"
],
"schema_version": "14.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/cucm/UniversalDeviceTemplate/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cucm/UniversalDeviceTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cucm/UniversalDeviceTemplate/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cucm/UniversalDeviceTemplate/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cucm/UniversalDeviceTemplate/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"logMissedCalls": true,
"servicesProvisioning": "Default",
"authenticationMode": "By Null String",
"speeddials": null,
"alwaysUsePrimeLineForVoiceMessage": "Default",
"mlppPreemption": "Default",
"mobilityUserId": "Token",
"callPickupGroupAudioAlertSettingPhoneIdle": "Use System Default",
"useTrustedRelayPoint": "Default",
"location": "Hub_None",
"ownerUserId": "Current Device Owner's User ID",
"aarCallingSearchSpace": null,
"userLocale": null,
"deviceMobilityMode": "Default",
"commonPhoneProfile": "Standard Common Phone Profile",
"loggedIntoHuntGroup": true,
"requiredDtmfReception": false,
"geoLocation": null,
"name": "Auto-registration Template",
"retryVideoCallAsAudio": true,
"userHoldMohAudioSource": null,
"builtInBridge": "Default",
"recordingProfile": null,
"aarGroup": null,
"protectedDevice": false,
"callingPartyTransformationCSSForOutboundCalls": null,
"keySize": "2048",
"requireOffPremiseLocation": false,
"MaxNumberOfCalls": 4,
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": true,
"subscribeCallingSearchSpaceName": null,
"externalPhoneNumber": null,
"rfc2833Disabled": false,
"displayCallerId": "#FirstName# #LastName#",
"hotlineDevice": false,
"outboundCallRollover": "No Rollover",
"mtpPreferredOriginatingCodec": "711ulaw",
"busyTrigger": 2,
"sipDialRules": null,
"audibleMsgWaitingicatorPolicy": "Default",
"networkHoldMohAudioSource": null,
"blfPresenceGroup": "Standard Presence group",
"dndIncomingCallAlert": null,
"sipProfile": "Standard SIP Profile",
"deviceSecurityProfile": "Universal Device Template - Model-independent Security Profile",
"privacy": "Default",
"singleButtonBarge": "Default",
"mlppIndication": "Default",
"enableExtensionMobility": false,
"ringSettingWhenPhoneIdle": "Ring",
"networkLocale": null,
"callingSearchSpace": null,
"softkeyTemplate": null,
"reroutingCallingSearchSpace": null,
"allowControlOfDeviceFromCti": true,
"joinAcrossLines": "Default",
"phonePersonalization": "Default",
"monitoringCallingSearchSpace": null,
"lineLabel": "#UserID# - #PrimaryExtension#",
"unattendedPort": false,
"idle": "https://CUCM:443/cucm-uds/xps/selfProvision",
"directoryNumber": null,
"mediaTerminationPointRequired": false,
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": true,
"callPickupGroupAudioAlertSettingPhoneActive": "Use System Default",
"phoneButtonTemplate": "Universal Device Template Button Layout",
"blfAudibleAlertSettingPhoneIdle": "Default",
"alwaysUsePrimeLine": "Default",
"blfAudibleAlertSettingPhoneBusy": "Default",
"commonDeviceConfiguration": null,
"packetCaptureDuration": 0,
"ringSettingWhenPhoneInUse": "Use System Default",
"featureControlPolicy": null,
"mediaResourceGroupList": null,
"idleTimer": 1,
"packetCaptureMode": "None",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"doNotDisturb": false,
"ignorePresentationIndicators": false,
"services": null,
"visualMsgWaitingIndicatorPolicy": "Use System Policy",
"dndOption": "Use Common Phone Profile Setting",
"devicePool": "Default",
"remoteDevice": false,
"recordingOptions": "Call Recording Disabled",
"callingPartyTransformationCSSForInboundCalls": null,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/UniversalDeviceTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "deviceDescription",
"title": "Device Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Auto-registration Template",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/",
"pkid": "5ae8a433affa931cce3a5176"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a433affa931cce3a5176"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a433affa931cce3a5176/?model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a433affa931cce3a5176"
},
{
"data": {
"commonPhoneProfile": "Standard Common Phone Profile",
"servicesProvisioning": "Default",
"authenticationMode": "By Null String",
"speeddials": null,
"keyOrder": "RSA Only",
"alwaysUsePrimeLineForVoiceMessage": "Default",
"mlppPreemption": "Default",
"mobilityUserId": "Token",
"callPickupGroupAudioAlertSettingPhoneIdle": "Use System Default",
"useTrustedRelayPoint": "Default",
"location": "Hub_None",
"ownerUserId": "Current Device Owner's User ID",
"aarCallingSearchSpace": null,
"userLocale": null,
"deviceMobilityMode": "Default",
"logMissedCalls": true,
"loggedIntoHuntGroup": true,
"requiredDtmfReception": false,
"geoLocation": null,
"name": "Auto-registration Template",
"retryVideoCallAsAudio": true,
"userHoldMohAudioSource": null,
"builtInBridge": "Default",
"recordingProfile": null,
"aarGroup": null,
"protectedDevice": false,
"callingPartyTransformationCSSForOutboundCalls": null,
"keySize": "2048",
"requireOffPremiseLocation": false,
"MaxNumberOfCalls": 4,
"doNotDisturb": false,
"subscribeCallingSearchSpaceName": null,
"externalPhoneNumber": null,
"rfc2833Disabled": false,
"displayCallerId": "#FirstName# #LastName#",
"hotlineDevice": false,
"outboundCallRollover": "No Rollover",
"mtpPreferredOriginatingCodec": "711ulaw",
"busyTrigger": 2,
"sipDialRules": null,
"audibleMsgWaitingicatorPolicy": "Default",
"networkHoldMohAudioSource": null,
"blfPresenceGroup": "Standard Presence group",
"dndIncomingCallAlert": null,
"sipProfile": "Standard SIP Profile",
"services": null,
"deviceSecurityProfile": "Universal Device Template - Model-independent Security Profile",
"privacy": "Default",
"singleButtonBarge": "Default",
"mlppIndication": "Default",
"enableExtensionMobility": false,
"ringSettingWhenPhoneIdle": "Ring",
"networkLocale": null,
"callingSearchSpace": null,
"softkeyTemplate": null,
"reroutingCallingSearchSpace": null,
"allowControlOfDeviceFromCti": true,
"joinAcrossLines": "Default",
"phonePersonalization": "Default",
"monitoringCallingSearchSpace": null,
"lineLabel": "#UserID# - #PrimaryExtension#",
"unattendedPort": false,
"idle": "https://CUCM:443/cucm-uds/xps/selfProvision",
"directoryNumber": null,
"mediaTerminationPointRequired": false,
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": true,
"callPickupGroupAudioAlertSettingPhoneActive": "Use System Default",
"phoneButtonTemplate": "Universal Device Template Button Layout",
"blfAudibleAlertSettingPhoneIdle": "Default",
"alwaysUsePrimeLine": "Default",
"blfAudibleAlertSettingPhoneBusy": "Default",
"commonDeviceConfiguration": null,
"packetCaptureDuration": 0,
"ringSettingWhenPhoneInUse": "Use System Default",
"featureControlPolicy": null,
"mediaResourceGroupList": null,
"idleTimer": 1,
"packetCaptureMode": "None",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": true,
"ignorePresentationIndicators": false,
"certificateOperation": "No Pending Operation",
"visualMsgWaitingIndicatorPolicy": "Use System Policy",
"dndOption": "Use Common Phone Profile Setting",
"devicePool": "Default",
"remoteDevice": false,
"recordingOptions": "Call Recording Disabled",
"callingPartyTransformationCSSForInboundCalls": null,
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/UniversalDeviceTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "deviceDescription",
"title": "Device Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Auto-registration Template",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/",
"pkid": "5ae8a46faffa931cce3a5fe2"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a46faffa931cce3a5fe2"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a46faffa931cce3a5fe2/?model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a46faffa931cce3a5fe2/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a46faffa931cce3a5fe2"
},
{
"data": {
"phonePersonalization": "Default",
"callPickupGroupAudioAlertSettingPhoneActive": "Use System Default",
"sipDialRules": null,
"blfPresenceGroup": "Standard Presence group",
"commonPhoneProfile": "Standard Common Phone Profile",
"servicesProvisioning": "Default",
"mlppIndication": "Default",
"recordingProfile": null,
"aarGroup": null,
"blfAudibleAlertSettingPhoneIdle": "Default",
"authenticationMode": "By Null String",
"callingPartyTransformationCSSForOutboundCalls": null,
"keySize": "2048",
"alwaysUsePrimeLineForVoiceMessage": "Default",
"blfAudibleAlertSettingPhoneBusy": "Default",
"deviceSecurityProfile": "Universal Device Template - Model-independent Security Profile",
"phoneButtonTemplate": "Universal Device Template Button Layout",
"mlppPreemption": "Default",
"allowControlOfDeviceFromCti": true,
"mobilityUserId": "Token",
"commonDeviceConfiguration": null,
"callPickupGroupAudioAlertSettingPhoneIdle": "Use System Default",
"privacy": "Default",
"dndOption": "Use Common Phone Profile Setting",
"useTrustedRelayPoint": "Default",
"singleButtonBarge": "Default",
"builtInBridge": "Default",
"remoteDevice": false,
"enableExtensionMobility": false,
"ignorePresentationIndicators": false,
"reroutingCallingSearchSpace": null,
"featureControlPolicy": null,
"location": "Hub_None",
"mediaResourceGroupList": null,
"ownerUserId": "Current Device Owner's User ID",
"requireOffPremiseLocation": false,
"packetCaptureDuration": 0,
"packetCaptureMode": "None",
"networkLocale": null,
"MaxNumberOfCalls": 4,
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": true,
"aarCallingSearchSpace": null,
"dndIncomingCallAlert": null,
"callingSearchSpace": null,
"subscribeCallingSearchSpaceName": null,
"monitoringCallingSearchSpace": null,
"doNotDisturb": false,
"protectedDevice": false,
"userLocale": null,
"sipProfile": "Standard SIP Profile",
"devicePool": "Default",
"ringSettingWhenPhoneIdle": "Ring",
"deviceMobilityMode": "Default",
"externalPhoneNumber": null,
"rfc2833Disabled": false,
"logMissedCalls": true,
"joinAcrossLines": "Default",
"speeddials": null,
"ringSettingWhenPhoneInUse": "Use System Default",
"loggedIntoHuntGroup": true,
"alwaysUsePrimeLine": "Default",
"visualMsgWaitingIndicatorPolicy": "Use System Policy",
"displayCallerId": "#FirstName# #LastName#",
"requiredDtmfReception": false,
"geoLocation": null,
"outboundCallRollover": "No Rollover",
"name": "Sample Device Template with TAG usage examples",
"retryVideoCallAsAudio": true,
"hotlineDevice": false,
"softkeyTemplate": null,
"busyTrigger": 2,
"mtpPreferredOriginatingCodec": "711ulaw",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"userHoldMohAudioSource": null,
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": true,
"networkHoldMohAudioSource": null,
"services": null,
"recordingOptions": "Call Recording Disabled",
"lineLabel": "#UserID# - #PrimaryExtension#",
"directoryNumber": null,
"mediaTerminationPointRequired": false,
"callingPartyTransformationCSSForInboundCalls": null,
"audibleMsgWaitingicatorPolicy": "Default",
"unattendedPort": false,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/UniversalDeviceTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "deviceDescription",
"title": "Device Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Sample Device Template with TAG usage examples",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/",
"pkid": "5ae8a433affa931cce3a518d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a433affa931cce3a518d"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a433affa931cce3a518d/?model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a518d/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a433affa931cce3a518d"
}
]
}
(Show the first instance)
{
"data": {
"logMissedCalls": true,
"servicesProvisioning": "Default",
"loggedIntoHuntGroup": true,
"speeddials": null,
"alwaysUsePrimeLineForVoiceMessage": "Default",
"mlppPreemption": "Default",
"mobilityUserId": "Token",
"callPickupGroupAudioAlertSettingPhoneIdle": "Use System Default",
"useTrustedRelayPoint": "Default",
"ownerUserId": "Current Device Owner's User ID",
"aarCallingSearchSpace": null,
"userLocale": null,
"deviceMobilityMode": "Default",
"commonPhoneProfile": "Standard Common Phone Profile",
"outboundCallRollover": "No Rollover",
"requiredDtmfReception": false,
"geoLocation": null,
"name": "Auto-registration Template",
"retryVideoCallAsAudio": true,
"authenticationMode": "By Null String",
"userHoldMohAudioSource": null,
"builtInBridge": "Default",
"recordingProfile": null,
"aarGroup": null,
"protectedDevice": false,
"callingPartyTransformationCSSForOutboundCalls": null,
"keySize": "2048",
"requireOffPremiseLocation": false,
"MaxNumberOfCalls": 4,
"doNotDisturb": false,
"audibleMsgWaitingicatorPolicy": "Default",
"subscribeCallingSearchSpaceName": null,
"externalPhoneNumber": null,
"rfc2833Disabled": false,
"directoryNumber": null,
"displayCallerId": "#FirstName# #LastName#",
"hotlineDevice": false,
"mtpPreferredOriginatingCodec": "711ulaw",
"busyTrigger": 2,
"sipDialRules": null,
"networkHoldMohAudioSource": null,
"blfPresenceGroup": "Standard Presence group",
"dndIncomingCallAlert": null,
"sipProfile": "Standard SIP Profile",
"deviceSecurityProfile": "Universal Device Template - Model-independent Security Profile",
"privacy": "Default",
"singleButtonBarge": "Default",
"mlppIndication": "Default",
"enableExtensionMobility": false,
"ringSettingWhenPhoneIdle": "Ring",
"location": "Hub_None",
"callingSearchSpace": null,
"softkeyTemplate": null,
"reroutingCallingSearchSpace": null,
"allowControlOfDeviceFromCti": true,
"joinAcrossLines": "Default",
"phonePersonalization": "Default",
"networkLocale": null,
"monitoringCallingSearchSpace": null,
"lineLabel": "#UserID# - #PrimaryExtension#",
"unattendedPort": false,
"idle": "https://CUCM:443/cucm-uds/xps/selfProvision",
"mediaTerminationPointRequired": false,
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": true,
"callPickupGroupAudioAlertSettingPhoneActive": "Use System Default",
"phoneButtonTemplate": "Universal Device Template Button Layout",
"blfAudibleAlertSettingPhoneIdle": "Default",
"alwaysUsePrimeLine": "Default",
"blfAudibleAlertSettingPhoneBusy": "Default",
"commonDeviceConfiguration": null,
"packetCaptureDuration": 0,
"ringSettingWhenPhoneInUse": "Use System Default",
"featureControlPolicy": null,
"mediaResourceGroupList": null,
"idleTimer": 1,
"packetCaptureMode": "None",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": true,
"ignorePresentationIndicators": false,
"services": null,
"visualMsgWaitingIndicatorPolicy": "Use System Policy",
"dndOption": "Use Common Phone Profile Setting",
"devicePool": "Default",
"remoteDevice": false,
"recordingOptions": "Call Recording Disabled",
"callingPartyTransformationCSSForInboundCalls": null
},
"meta": {
"model_type": "device/cucm/UniversalDeviceTemplate",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "deviceDescription",
"title": "Device Description"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Auto-registration Template",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/",
"pkid": "5ae8a433affa931cce3a5176"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a433affa931cce3a5176"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a433affa931cce3a5176/?hierarchy=[hierarchy]&model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5ae8a433affa931cce3a5176/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a433affa931cce3a5176"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/UniversalDeviceTemplate. | GET | /api/device/cucm/UniversalDeviceTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/UniversalDeviceTemplate as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/UniversalDeviceTemplate/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/UniversalDeviceTemplate/[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/UniversalDeviceTemplate/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/UniversalDeviceTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/UniversalDeviceTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/UniversalDeviceTemplate | 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/UniversalDeviceTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/UniversalDeviceTemplate/[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/UniversalDeviceTemplate and the JSON format can be used to import instances of device/cucm/UniversalDeviceTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/UniversalDeviceTemplate/[pkid] | hierarchy=[hierarchy] | The device/cucm/UniversalDeviceTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/UniversalDeviceTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/UniversalDeviceTemplate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/UniversalDeviceTemplate/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |