[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": {
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"deviceDescription": {
"title": "Device Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"devicePool": {
"title": "Device Pool",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/DevicePool",
"choices": []
},
"deviceSecurityProfile": {
"title": "Device Security Profile",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/PhoneSecurityProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/PhoneSecurityProfile",
"choices": []
},
"sipProfile": {
"title": "Sip Profile",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/SipProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/SipProfile",
"choices": []
},
"phoneButtonTemplate": {
"title": "Phone Button Template",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"choices": [
[
"Universal Device Template Button Layout",
"Universal Device Template Button Layout"
]
]
},
"sipDialRules": {
"title": "Sip Dial Rules",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/SipDialRules/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/SipDialRules",
"choices": []
},
"callingSearchSpace": {
"title": "Calling Search Space",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"callingPartyTransformationCSSForInboundCalls": {
"title": "Calling Party Transformation CSS For Inbound Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"callingPartyTransformationCSSForOutboundCalls": {
"title": "Calling Party Transformation CSS For Outbound Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"reroutingCallingSearchSpace": {
"title": "Rerouting Calling Search Space",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"subscribeCallingSearchSpaceName": {
"title": "Subscribe Calling Search Space Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": {
"title": "Use Device Pool Calling Party Transformation CS Sfor Inbound Calls",
"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"
},
"commonPhoneProfile": {
"title": "Common Phone Profile",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/CommonPhoneConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/CommonPhoneConfig",
"choices": []
},
"commonDeviceConfiguration": {
"title": "Common Device Configuration",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/CommonDeviceConfig/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/CommonDeviceConfig",
"choices": []
},
"softkeyTemplate": {
"title": "Softkey Template",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/SoftKeyTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/SoftKeyTemplate",
"choices": []
},
"featureControlPolicy": {
"title": "Feature Control Policy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/FeatureControlPolicy/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/FeatureControlPolicy",
"choices": []
},
"phonePersonalization": {
"title": "Phone Personalization",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "Enabled",
"value": "Enabled"
},
{
"title": "HTTPS Only",
"value": "HTTPS Only"
},
{
"title": "Default",
"value": "Default"
}
]
},
"mtpPreferredOriginatingCodec": {
"title": "Mtp Preferred Originating Codec",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "711ulaw",
"type": "string",
"choices": [
{
"title": "711ulaw",
"value": "711ulaw"
},
{
"title": "711alaw",
"value": "711alaw"
},
{
"title": "G729/G729a",
"value": "G729/G729a"
},
{
"title": "G729b/G729ab",
"value": "G729b/G729ab"
}
]
},
"outboundCallRollover": {
"title": "Outbound Call Rollover",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "No Rollover",
"type": "string",
"choices": [
{
"title": "No Rollover",
"value": "No Rollover"
},
{
"title": "Rollover Within Same DN",
"value": "Rollover Within Same DN"
},
{
"title": "Rollover to any line",
"value": "Rollover to any line"
}
]
},
"mediaTerminationPointRequired": {
"title": "Media Termination Point Required",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"unattendedPort": {
"title": "Unattended Port",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"requiredDtmfReception": {
"title": "Required Dtmf Reception",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"rfc2833Disabled": {
"title": "Rfc2833Disabled",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"speeddials": {
"title": "Speeddials",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"speeddial": {
"name": "speeddial",
"title": "Speeddial",
"minItems": 0,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"dirn": {
"name": "dirn",
"title": "Dirn",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"label": {
"name": "label",
"title": "Label",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
}
}
}
}
}
},
"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.",
"name": "line",
"title": "Line",
"minItems": 0,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"display": {
"name": "display",
"title": "Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"e164Mask": {
"name": "e164Mask",
"title": "E164Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"maxLength": 255
},
"dirn": {
"description": "Only uuid attribute is returned in response",
"name": "dirn",
"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,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
}
},
"maxNumCalls": {
"name": "maxNumCalls",
"title": "Max Num Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 2,
"type": "integer"
},
"missedCallLogging": {
"name": "missedCallLogging",
"title": "Missed Call Logging",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": true,
"type": "boolean"
},
"mwlPolicy": {
"name": "mwlPolicy",
"title": "Mwl Policy",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Use System Policy",
"type": "string",
"choices": [
{
"title": "Use System Policy",
"value": "Use System Policy"
},
{
"title": "Light and Prompt",
"value": "Light and Prompt"
},
{
"title": "Prompt Only",
"value": "Prompt Only"
},
{
"title": "Light Only",
"value": "Light Only"
},
{
"title": "None",
"value": "None"
}
]
},
"busyTrigger": {
"name": "busyTrigger",
"title": "Busy Trigger",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 1,
"type": "integer"
},
"ringSetting": {
"name": "ringSetting",
"title": "Ring Setting",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Ring",
"type": "string",
"choices": [
{
"title": "Use System Default",
"value": "Use System Default"
},
{
"title": "Disable",
"value": "Disable"
},
{
"title": "Flash Only",
"value": "Flash Only"
},
{
"title": "Ring Once",
"value": "Ring Once"
},
{
"title": "Ring",
"value": "Ring"
},
{
"title": "Beep Only",
"value": "Beep Only"
}
]
},
"consecutiveRingSetting": {
"description": "Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.",
"name": "consecutiveRingSetting",
"title": "Consecutive Ring Setting",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Use System Default",
"type": [
"string",
"null"
],
"choices": [
{
"title": "Use System Default",
"value": "Use System Default"
},
{
"title": "Disable",
"value": "Disable"
},
{
"title": "Flash Only",
"value": "Flash Only"
},
{
"title": "Ring Once",
"value": "Ring Once"
},
{
"title": "Ring",
"value": "Ring"
},
{
"title": "Beep Only",
"value": "Beep Only"
}
]
},
"audibleMwi": {
"description": "Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway",
"name": "audibleMwi",
"title": "Audible Mwi",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"ringSettingActivePickupAlert": {
"description": "Applicable only for IP Phones",
"name": "ringSettingActivePickupAlert",
"title": "Ring Setting Active Pickup Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Use System Default",
"type": [
"string",
"null"
],
"choices": [
{
"title": "Use System Default",
"value": "Use System Default"
},
{
"title": "Disable",
"value": "Disable"
},
{
"title": "Flash Only",
"value": "Flash Only"
},
{
"title": "Ring Once",
"value": "Ring Once"
},
{
"title": "Ring",
"value": "Ring"
},
{
"title": "Beep Only",
"value": "Beep Only"
}
]
},
"ringSettingIdlePickupAlert": {
"description": "Applicable only for IP Phones",
"name": "ringSettingIdlePickupAlert",
"title": "Ring Setting Idle Pickup Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Use System Default",
"type": [
"string",
"null"
],
"choices": [
{
"title": "Use System Default",
"value": "Use System Default"
},
{
"title": "Disable",
"value": "Disable"
},
{
"title": "Flash Only",
"value": "Flash Only"
},
{
"title": "Ring Once",
"value": "Ring Once"
},
{
"title": "Ring",
"value": "Ring"
},
{
"title": "Beep Only",
"value": "Beep Only"
}
]
},
"monitoringCssName": {
"name": "monitoringCssName",
"title": "Monitoring Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"recordingProfileName": {
"name": "recordingProfileName",
"title": "Recording Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"recordingFlag": {
"name": "recordingFlag",
"title": "Recording Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Call Recording Disabled",
"type": "string",
"choices": [
{
"title": "Call Recording Disabled",
"value": "Call Recording Disabled"
},
{
"title": "Automatic Call Recording Enabled",
"value": "Automatic Call Recording Enabled"
},
{
"title": "Selective Call Recording Enabled",
"value": "Selective Call Recording Enabled"
}
]
},
"recordingMediaSource": {
"name": "recordingMediaSource",
"title": "Recording Media Source",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Gateway Preferred",
"type": "string",
"choices": [
{
"title": "Gateway Preferred",
"value": "Gateway Preferred"
},
{
"title": "Phone Preferred",
"value": "Phone Preferred"
}
]
},
"callInfoDisplay": {
"name": "callInfoDisplay",
"title": "Call Info Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"callerName": {
"name": "callerName",
"title": "Caller Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": true,
"type": "boolean"
},
"callerNumber": {
"name": "callerNumber",
"title": "Caller Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"redirectedNumber": {
"name": "redirectedNumber",
"title": "Redirected Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"dialedNumber": {
"name": "dialedNumber",
"title": "Dialed Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": true,
"type": "boolean"
}
}
}
}
}
},
"lineIdentifier": {
"description": "The lineIdentifier is a shorthand method that refers to a particular directory number.",
"name": "lineIdentifier",
"title": "Line Identifier",
"minItems": 0,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"directoryNumber": {
"name": "directoryNumber",
"title": "Directory Number",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"maxLength": 50
}
}
}
}
}
},
"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,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"directedCallParkId": {
"description": "Only the uuid attribute is read",
"name": "directedCallParkId",
"title": "Directed Call Park Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"pattern": "\\{........-....-....-....-............\\}"
},
"directedCallParkDnAndPartition": {
"name": "directedCallParkDnAndPartition",
"title": "Directed Call Park Dn And Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"dnPattern": {
"name": "dnPattern",
"title": "Dn Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
}
},
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
}
}
}
}
}
},
"busyLampFields": {
"title": "Busy Lamp Fields",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"busyLampField": {
"name": "busyLampField",
"title": "Busy Lamp Field",
"minItems": 0,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"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.",
"name": "blfDest",
"title": "Blf Dest",
"minItems": 1,
"required": true,
"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.",
"name": "blfDirn",
"title": "Blf Dirn",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 255
},
"routePartition": {
"name": "routePartition",
"title": "Route Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"label": {
"name": "label",
"title": "Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"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,
"required": false,
"type": "array",
"items": {
"type": "string",
"choices": [
{
"title": "Pickup",
"value": "Pickup"
}
]
}
}
}
},
"index": {
"name": "index",
"title": "Index",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
}
}
}
}
}
},
"useTrustedRelayPoint": {
"title": "Use Trusted Relay Point",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"protectedDevice": {
"title": "Protected Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"certificateOperation": {
"title": "Certificate Operation",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "No Pending Operation",
"type": "string",
"choices": [
{
"title": "No Pending Operation",
"value": "No Pending Operation"
},
{
"title": "Install/Upgrade",
"value": "Install/Upgrade"
},
{
"title": "Delete",
"value": "Delete"
},
{
"title": "Troubleshoot",
"value": "Troubleshoot"
}
]
},
"authenticationMode": {
"title": "Authentication Mode",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "By Null String",
"type": "string",
"choices": [
{
"title": "By Authentication String",
"value": "By Authentication String"
},
{
"title": "By Null String",
"value": "By Null String"
},
{
"title": "By Existing Certificate (precedence to LSC)",
"value": "By Existing Certificate (precedence to LSC)"
},
{
"title": "By Existing Certificate (precedence to MIC)",
"value": "By Existing Certificate (precedence to MIC)"
}
]
},
"authenticationString": {
"title": "Authentication String",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"keySize": {
"title": "Key Size",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "2048",
"type": "string",
"choices": [
{
"title": "512",
"value": "512"
},
{
"title": "1024",
"value": "1024"
},
{
"title": "2048",
"value": "2048"
},
{
"title": "3072",
"value": "3072"
},
{
"title": "4096",
"value": "4096"
}
]
},
"keyOrder": {
"title": "Key Order",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "RSA Only",
"type": "string",
"choices": [
{
"title": "RSA Only",
"value": "RSA Only"
},
{
"title": "EC Only",
"value": "EC Only"
},
{
"title": "EC Preferred, RSA Backup",
"value": "EC Preferred, RSA Backup"
}
]
},
"ecKeySize": {
"title": "Ec Key Size",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"choices": [
{
"title": "256",
"value": "256"
},
{
"title": "384",
"value": "384"
},
{
"title": "521",
"value": "521"
}
]
},
"servicesProvisioning": {
"title": "Services Provisioning",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Internal",
"value": "Internal"
},
{
"title": "External URL",
"value": "External URL"
},
{
"title": "Both",
"value": "Both"
},
{
"title": "Default",
"value": "Default"
}
]
},
"packetCaptureMode": {
"title": "Packet Capture Mode",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "None",
"type": "string",
"choices": [
{
"title": "None",
"value": "None"
},
{
"title": "Batch Processing Mode",
"value": "Batch Processing Mode"
}
]
},
"packetCaptureDuration": {
"title": "Packet Capture Duration",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 0,
"type": [
"integer",
"null"
]
},
"secureShellUser": {
"title": "Secure Shell User",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureShellPassword": {
"is_password": true,
"title": "Secure Shell Password",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"userLocale": {
"title": "User Locale",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"choices": [],
"format": "uri",
"target": "/api/device/cucm/UserLocale/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/UserLocale"
},
"networkLocale": {
"title": "Network Locale",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"choices": [],
"format": "uri",
"target": "/api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Country"
},
"mlppDomain": {
"title": "Mlpp Domain",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/MlppDomain/choices/?field=domainName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "domainName",
"target_model_type": "device/cucm/MlppDomain",
"choices": []
},
"mlppIndication": {
"title": "Mlpp Indication",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Off",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"mlppPreemption": {
"title": "Mlpp Preemption",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Disabled",
"value": "Disabled"
},
{
"title": "Forceful",
"value": "Forceful"
},
{
"title": "Default",
"value": "Default"
}
]
},
"doNotDisturb": {
"title": "Do Not Disturb",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"dndOption": {
"title": "Dnd Option",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Ringer Off",
"type": "string",
"choices": [
{
"title": "Ringer Off",
"value": "Ringer Off"
},
{
"title": "Call Reject",
"value": "Call Reject"
},
{
"title": "Use Common Phone Profile Setting",
"value": "Use Common Phone Profile Setting"
}
]
},
"dndIncomingCallAlert": {
"title": "Dnd Incoming Call Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"choices": [
{
"title": "Use System Default",
"value": "Use System Default"
},
{
"title": "Disable",
"value": "Disable"
},
{
"title": "Flash Only",
"value": "Flash Only"
},
{
"title": "Ring Once",
"value": "Ring Once"
},
{
"title": "Ring",
"value": "Ring"
},
{
"title": "Beep Only",
"value": "Beep Only"
}
]
},
"aarGroup": {
"title": "Aar Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/AarGroup",
"choices": []
},
"aarCallingSearchSpace": {
"title": "Aar Calling Search Space",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"blfPresenceGroup": {
"title": "Blf Presence Group",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/PresenceGroup",
"choices": []
},
"blfAudibleAlertSettingPhoneBusy": {
"title": "Blf Audible Alert Setting Phone Busy",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"blfAudibleAlertSettingPhoneIdle": {
"title": "Blf Audible Alert Setting Phone Idle",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"userHoldMohAudioSource": {
"title": "User Hold Moh Audio Source",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null",
"integer"
],
"format": "uri",
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "sourceId",
"target_model_type": "device/cucm/MohAudioSource",
"choices": []
},
"networkHoldMohAudioSource": {
"title": "Network Hold Moh Audio Source",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null",
"integer"
],
"format": "uri",
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "sourceId",
"target_model_type": "device/cucm/MohAudioSource",
"choices": []
},
"location": {
"title": "Location",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Location",
"choices": []
},
"geoLocation": {
"title": "Geo Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/GeoLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/GeoLocation",
"choices": []
},
"deviceMobilityMode": {
"title": "Device Mobility Mode",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"mediaResourceGroupList": {
"title": "Media Resource Group List",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/MediaResourceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/MediaResourceList",
"choices": []
},
"remoteDevice": {
"title": "Remote Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"hotlineDevice": {
"title": "Hotline Device",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"retryVideoCallAsAudio": {
"title": "Retry Video Call As Audio",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"requireOffPremiseLocation": {
"title": "Require Off Premise Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"ownerUserId": {
"title": "Owner User Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/User/choices/?choices_source=device/cucm/UniversalDeviceTemplate&field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "userid",
"target_model_type": "device/cucm/User",
"choices": []
},
"mobilityUserId": {
"title": "Mobility User Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/User/choices/?choices_source=device/cucm/UniversalDeviceTemplate&field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "userid",
"target_model_type": "device/cucm/User",
"choices": []
},
"joinAcrossLines": {
"title": "Join Across Lines",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"alwaysUsePrimeLine": {
"title": "Always Use Prime Line",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"alwaysUsePrimeLineForVoiceMessage": {
"title": "Always Use Prime Line For Voice Message",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"singleButtonBarge": {
"title": "Single Button Barge",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "Barge",
"value": "Barge"
},
{
"title": "CBarge",
"value": "CBarge"
},
{
"title": "Default",
"value": "Default"
}
]
},
"builtInBridge": {
"title": "Built In Bridge",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"allowControlOfDeviceFromCti": {
"title": "Allow Control Of Device From Cti",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"ignorePresentationIndicators": {
"title": "Ignore Presentation Indicators",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"enableExtensionMobility": {
"title": "Enable Extension Mobility",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"privacy": {
"title": "Privacy",
"minItems": 1,
"required": true,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"loggedIntoHuntGroup": {
"title": "Logged Into Hunt Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"proxyServer": {
"title": "Proxy Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"servicesUrl": {
"title": "Services Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"idle": {
"title": "Idle",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"idleTimer": {
"title": "Idle Timer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"secureDirUrl": {
"title": "Secure Dir Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"messages": {
"title": "Messages",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureIdleUrl": {
"title": "Secure Idle Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"authenticationServer": {
"title": "Authentication Server",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"directory": {
"title": "Directory",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureServicesUrl": {
"title": "Secure Services Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"information": {
"title": "Information",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureMessagesUrl": {
"title": "Secure Messages Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureInformationUrl": {
"title": "Secure Information Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"secureAuthenticationUrl": {
"title": "Secure Authentication Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"services": {
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"service": {
"name": "service",
"title": "Service",
"minItems": 0,
"required": false,
"type": "array",
"items": {
"type": [
"object",
"null"
],
"properties": {
"telecasterServiceName": {
"name": "telecasterServiceName",
"title": "Telecaster Service Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"name": {
"name": "name",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"maxLength": 100
},
"url": {
"name": "url",
"title": "Url",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"urlButtonIndex": {
"name": "urlButtonIndex",
"title": "Url Button Index",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": 0,
"type": "integer"
},
"urlLabel": {
"name": "urlLabel",
"title": "Url Label",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"serviceNameAscii": {
"name": "serviceNameAscii",
"title": "Service Name Ascii",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
}
}
}
}
}
}
},
"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": 2,
"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": [
"export",
"help",
"update",
"get",
"move",
"remove",
"list",
"configuration_template",
"export_bulkload_template",
"transform",
"field_display_policy",
"bulk_update_form",
"add"
],
"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": [
"export",
"help",
"update",
"get",
"move",
"remove",
"list",
"configuration_template",
"export_bulkload_template",
"clone",
"field_display_policy",
"bulk_update_form",
"add"
],
"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,
"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",
"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",
"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#)",
"doNotDisturb": false,
"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.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/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/",
"pkid": "5df0babece894e00127710c9"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0babece894e00127710c9"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5df0babece894e00127710c9/?model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5df0babece894e00127710c9"
},
{
"data": {
"logMissedCalls": true,
"servicesProvisioning": "Default",
"hierarchy": "5df0b66bce894e001275a913",
"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",
"commonPhoneProfile": "Standard Common Phone Profile",
"loggedIntoHuntGroup": true,
"requiredDtmfReception": false,
"geoLocation": null,
"name": "Sample Device Template with TAG usage examples",
"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",
"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,
"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,
"packetCaptureMode": "None",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"doNotDisturb": false,
"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.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/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/",
"pkid": "5df0babece894e00127710d2"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0babece894e00127710d2"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5df0babece894e00127710d2/?model_type=device/cucm/UniversalDeviceTemplate",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710d2/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5df0babece894e00127710d2"
}
]
}
(Show the first instance)
{
"data": {
"name": "Auto-registration Template",
"deviceDescription": "#FirstName# #LastName# (#Product# #Protocol#)",
"devicePool": "Default",
"deviceSecurityProfile": "Universal Device Template - Model-independent Security Profile",
"sipProfile": "Standard SIP Profile",
"phoneButtonTemplate": "Universal Device Template Button Layout",
"sipDialRules": null,
"callingSearchSpace": null,
"callingPartyTransformationCSSForInboundCalls": null,
"callingPartyTransformationCSSForOutboundCalls": null,
"reroutingCallingSearchSpace": null,
"subscribeCallingSearchSpaceName": null,
"useDevicePoolCallingPartyTransformationCSSforInboundCalls": true,
"useDevicePoolCallingPartyTransformationCSSforOutboundCalls": true,
"commonPhoneProfile": "Standard Common Phone Profile",
"commonDeviceConfiguration": null,
"softkeyTemplate": null,
"featureControlPolicy": null,
"phonePersonalization": "Default",
"mtpPreferredOriginatingCodec": "711ulaw",
"outboundCallRollover": "No Rollover",
"mediaTerminationPointRequired": false,
"unattendedPort": false,
"requiredDtmfReception": false,
"rfc2833Disabled": false,
"speeddials": null,
"useTrustedRelayPoint": "Default",
"protectedDevice": false,
"certificateOperation": "No Pending Operation",
"authenticationMode": "By Null String",
"keySize": "2048",
"keyOrder": "RSA Only",
"servicesProvisioning": "Default",
"packetCaptureMode": "None",
"packetCaptureDuration": 0,
"userLocale": null,
"networkLocale": null,
"mlppIndication": "Default",
"mlppPreemption": "Default",
"doNotDisturb": false,
"dndOption": "Use Common Phone Profile Setting",
"dndIncomingCallAlert": null,
"aarGroup": null,
"aarCallingSearchSpace": null,
"blfPresenceGroup": "Standard Presence group",
"blfAudibleAlertSettingPhoneBusy": "Default",
"blfAudibleAlertSettingPhoneIdle": "Default",
"userHoldMohAudioSource": null,
"networkHoldMohAudioSource": null,
"location": "Hub_None",
"geoLocation": null,
"deviceMobilityMode": "Default",
"mediaResourceGroupList": null,
"remoteDevice": false,
"hotlineDevice": false,
"retryVideoCallAsAudio": true,
"requireOffPremiseLocation": false,
"ownerUserId": "Current Device Owner's User ID",
"mobilityUserId": "Token",
"joinAcrossLines": "Default",
"alwaysUsePrimeLine": "Default",
"alwaysUsePrimeLineForVoiceMessage": "Default",
"singleButtonBarge": "Default",
"builtInBridge": "Default",
"allowControlOfDeviceFromCti": true,
"ignorePresentationIndicators": false,
"enableExtensionMobility": false,
"recordingOptions": "Call Recording Disabled",
"privacy": "Default",
"loggedIntoHuntGroup": true,
"idle": "https://CUCM:443/cucm-uds/xps/selfProvision",
"idleTimer": 1,
"externalPhoneNumber": null,
"audibleMsgWaitingicatorPolicy": "Default",
"logMissedCalls": true,
"visualMsgWaitingIndicatorPolicy": "Use System Policy",
"lineLabel": "#UserID# - #PrimaryExtension#",
"displayCallerId": "#FirstName# #LastName#",
"MaxNumberOfCalls": 4,
"ringSettingWhenPhoneIdle": "Ring",
"busyTrigger": 2,
"ringSettingWhenPhoneInUse": "Use System Default",
"directoryNumber": null,
"recordingProfile": null,
"callPickupGroupAudioAlertSettingPhoneActive": "Use System Default",
"callPickupGroupAudioAlertSettingPhoneIdle": "Use System Default",
"monitoringCallingSearchSpace": null,
"services": 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/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913",
"pkid": "5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/",
"pkid": "5df0babece894e00127710c9"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0babece894e00127710c9"
],
"schema_version": "11.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5df0babece894e00127710c9/?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/5df0babece894e00127710c9/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/5df0babece894e00127710c9/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/UniversalDeviceTemplate/5df0babece894e00127710c9/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5df0babece894e00127710c9"
}
| 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: |