[Index]
Model ref.: device/cucm/PhoneType
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": {
"PhoneNameFormat": {
"type": "string",
"description": "The format for the name of the CUCM Phone Type",
"title": "Phone Name Format"
},
"ProtocolTemplates": {
"items": {
"type": "object",
"properties": {
"PBT": {
"items": {
"type": "string"
},
"type": "array",
"description": "Available phone button templates for this CUCM phone type & protocol",
"name": "PBT",
"title": "Default Phone Button Template"
},
"Protocol": {
"type": "string",
"description": "One of the protocols available for this CUCM phone type",
"name": "Protocol",
"title": "Protocol"
},
"SupportedFeatures": {
"items": {
"type": "string"
},
"type": "array",
"description": "Supported Features for this CUCM phone type & protocol",
"name": "SupportedFeatures",
"title": "Supported Features"
},
"VendorConfig": {
"type": [
"string"
],
"description": "JSON string - Available vendor config for this CUCM phone type & protocol",
"name": "VendorConfig",
"title": "Vendor Config"
},
"ExcludedSchemaKeys": {
"items": {
"type": "string"
},
"type": "array",
"description": "Schema keys to exclude for this CUCM phone type & protocol",
"name": "ExcludedSchemaKeys",
"title": "Excluded Schema Keys"
},
"SupportsActivationCode": {
"type": "boolean",
"description": "If this CUCM phone type & protocol supports the phone activation code feature",
"name": "SupportsActivationCode",
"title": "Supports Activation Code"
},
"SecurityProfile": {
"items": {
"type": "string"
},
"type": "array",
"description": "Available security profiles for this CUCM phone type & protocol",
"name": "SecurityProfile",
"title": "Phone Security Profile"
},
"phoneExpansionModules": {
"description": "Phone Expansion Module options for this phone type",
"title": "Expansion Modules",
"items": {
"type": "string"
},
"required": false,
"type": "array",
"name": "phoneExpansionModules"
}
}
},
"type": "array",
"description": "Available options for this CUCM phone type",
"title": "Protocol and Templates"
},
"PhoneType": {
"type": "string",
"description": "The CUCM Phone Type name",
"title": "Phone Type Name"
},
"PhoneNamePrefix": {
"type": "string",
"description": "The prefix for the name of the CUCM Phone Type",
"title": "Phone Name Prefix"
},
"PhoneNameExample": {
"type": "string",
"description": "An example of the name of the CUCM Phone Type",
"title": "Phone Name Example"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/PhoneType/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/PhoneType/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/PhoneType/[pkid1]", "/api/v0/device/cucm/PhoneType/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/PhoneType/?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/PhoneType |
|
{"hrefs": ["/api/device/cucm/PhoneType/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/PhoneType |
|
{"hrefs": ["/api/device/cucm/PhoneType/[pkid1]", "/api/device/cucm/PhoneType/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/PhoneType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/PhoneType/export/ |
|
{ "hrefs":["/api/device/cucm/PhoneType/[pkid1]", "/api/device/cucm/PhoneType/[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/PhoneType and the JSON format can be used to import instances of device/cucm/PhoneType.
GET http://[host-proxy]/api/device/cucm/PhoneType/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/PhoneType | POST | /api/device/cucm/PhoneType/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/PhoneType/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/PhoneType/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/PhoneType/ |
|
The device/cucm/PhoneType schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/PhoneType instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"export_bulkload_template",
"move",
"list",
"transform",
"export",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "PhoneType",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/PhoneType/?skip=0&limit=3&order_by=PhoneType&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 613
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/PhoneType/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/PhoneType",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneType/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cucm/PhoneType/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/PhoneType/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/PhoneType/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/PhoneType/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneType/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneType/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/PhoneType",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"bulk_update_form",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "PhoneType",
"title": "Phone Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "61b131f0eadb826afd7c6539",
"meta": {
"tags": [],
"cached": true,
"title": "Carrier-integrated Mobile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f01eadb826afd7b7a24",
"href": "/api/v0/data/CallManager/61b12f01eadb826afd7b7a24"
}
],
"self": [
{
"pkid": "61b131f0eadb826afd7c6539",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/"
}
],
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b131f0eadb826afd7c6539/?model_type=device/cucm/PhoneType",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/PhoneType",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b131f0eadb826afd7c6539"
],
"summary_attrs": [
{
"name": "PhoneType",
"title": "Phone Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"PhoneNameExample": "KHq",
"hierarchy": "61b12e93eadb826afd7b5dad",
"PhoneNameFormat": "^[0-9a-zA-Z]{1,15}$",
"PhoneType": "Carrier-integrated Mobile",
"PhoneNamePrefix": "",
"hierarchy_friendly_name": "CS-P (Provider)",
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"ProtocolTemplates": [
{
"PBT": [
"Standard Carrier-integrated Mobile"
],
"Protocol": "SIP",
"SupportedFeatures": [
"Automated Alternate Routing (AAR)",
"Call Waiting",
"Connected Transfer and Conference",
"Digest authentication support",
"Do Not Disturb",
"Dual-Mode",
"Enhanced Message Waiting Indicator",
"Has phone templates",
"Hold Reversion",
"Localization",
"Mobility",
"Multiple Call Display",
"Music On Hold",
"Network Hold",
"Presence Subscription",
"Privacy",
"Record",
"SIP TCP Support",
"Shared Line Appearance",
"Specify Types of TFTP Config Files",
"Use Generic Icon",
"User Hold",
"Virtual Private Network Client"
],
"VendorConfig": "{}",
"ExcludedSchemaKeys": [
"directoryUrl",
"protocol",
"secureInformationUrl",
"secureServicesUrl",
"authenticationUrl",
"authenticationMode",
"softkeyTemplateName",
"keyOrder",
"defaultProfileName",
"alwaysUsePrimeLineForVoiceMessage",
"enableCallRoutingToRdWhenNoneIsActive",
"allowCtiControlFlag",
"useTrustedRelayPoint",
"singleButtonBarge",
"messagesUrl",
"enableExtensionMobility",
"authenticationString",
"commonDeviceConfigName",
"secureIdleUrl",
"earlyOfferSupportForVoiceCall",
"informationUrl",
"secureAuthenticationUrl",
"blockIncomingCallsWhenRoaming",
"ringSettingBusyBlfAudibleAlert",
"secureMessageUrl",
"msisdn",
"phoneSuite",
"geoLocationName",
"deviceMobilityMode",
"joinAcrossLines",
"outboundCallRollover",
"primaryPhoneName",
"retryVideoCallAsAudio",
"wirelessLanProfileGroup",
"geoLocationFilterName",
"addOnModules.addOnModule.index",
"phoneServiceDisplay",
"addOnModules.addOnModule",
"networkLocation",
"requireDtmfReception",
"secureDirectoryUrl",
"addOnModules.addOnModule.model",
"ecKeySize",
"deviceTrustMode",
"mlppDomainId",
"requireThirdPartyRegistration",
"homeNetworkId",
"alwaysUsePrimeLine",
"idleUrl",
"proxyServerUrl",
"sshPwd",
"ringSettingIdleBlfAudibleAlert",
"builtInBridgeStatus",
"addOnModules",
"packetCaptureDuration",
"wifiHotspotProfile",
"AllowPresentationSharingUsingBfcp",
"traceFlag",
"featureControlPolicy",
"mlppIndicationStatus",
"requireOffPremiseLocation",
"packetCaptureMode",
"loadInformation",
"sendGeoLocation",
"isProtected",
"subscribeCallingSearchSpaceName",
"preemption",
"rfc2833Disabled",
"addOnModules.addOnModule.loadInformation",
"hlogStatus",
"upgradeFinishTime",
"certificateOperation",
"sshUserId",
"allowiXApplicableMedia",
"hotlineDevice",
"dndRingSetting",
"protocolSide",
"commonPhoneConfigName",
"idleTimeout",
"mtpPreferedCodec",
"addOnModules__addOnModule__loadInformation",
"remoteDevice",
"isDualMode",
"dialRulesName"
],
"SecurityProfile": [
"Universal Device Template - Security Profile - Encrypted - Device_TFTP",
"Universal Device Template - Security Profile - Encrypted",
"Universal Device Template - Security Profile - Authenticated",
"Universal Device Template - Security Profile - Non-Secure",
"Universal Device Template - Security Profile - Encrypted EC preferred",
"Carrier-integrated Mobile - Standard SIP Non-Secure Profile"
]
}
],
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "61b133eceadb826afd7cda39",
"meta": {
"tags": [],
"cached": true,
"title": "Carrier-integrated Mobile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f2feadb826afd7b858f",
"href": "/api/v0/data/CallManager/61b12f2feadb826afd7b858f"
}
],
"self": [
{
"pkid": "61b133eceadb826afd7cda39",
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b133eceadb826afd7cda39/?model_type=device/cucm/PhoneType",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/PhoneType/61b133eceadb826afd7cda39/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/PhoneType",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b133eceadb826afd7cda39"
],
"summary_attrs": [
{
"name": "PhoneType",
"title": "Phone Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"PhoneNameExample": "KHq",
"hierarchy": "61b12edfeadb826afd7b715a",
"PhoneNameFormat": "^[0-9a-zA-Z]{1,15}$",
"PhoneType": "Carrier-integrated Mobile",
"PhoneNamePrefix": "",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"ProtocolTemplates": [
{
"PBT": [
"Standard Carrier-integrated Mobile"
],
"Protocol": "SIP",
"SupportedFeatures": [
"Automated Alternate Routing (AAR)",
"Call Waiting",
"Connected Transfer and Conference",
"Digest authentication support",
"Do Not Disturb",
"Dual-Mode",
"Enhanced Message Waiting Indicator",
"Has phone templates",
"Hold Reversion",
"Localization",
"Mobility",
"Multiple Call Display",
"Music On Hold",
"Network Hold",
"Presence Subscription",
"Privacy",
"Record",
"SIP TCP Support",
"Shared Line Appearance",
"Specify Types of TFTP Config Files",
"Use Generic Icon",
"User Hold",
"Virtual Private Network Client"
],
"VendorConfig": "{}",
"ExcludedSchemaKeys": [
"directoryUrl",
"protocol",
"secureInformationUrl",
"secureServicesUrl",
"authenticationUrl",
"authenticationMode",
"softkeyTemplateName",
"keyOrder",
"defaultProfileName",
"alwaysUsePrimeLineForVoiceMessage",
"enableCallRoutingToRdWhenNoneIsActive",
"mraServiceDomain",
"allowCtiControlFlag",
"useTrustedRelayPoint",
"singleButtonBarge",
"messagesUrl",
"enableExtensionMobility",
"authenticationString",
"commonDeviceConfigName",
"secureIdleUrl",
"earlyOfferSupportForVoiceCall",
"informationUrl",
"secureAuthenticationUrl",
"blockIncomingCallsWhenRoaming",
"ringSettingBusyBlfAudibleAlert",
"secureMessageUrl",
"msisdn",
"phoneSuite",
"geoLocationName",
"deviceMobilityMode",
"joinAcrossLines",
"outboundCallRollover",
"primaryPhoneName",
"retryVideoCallAsAudio",
"wirelessLanProfileGroup",
"geoLocationFilterName",
"addOnModules.addOnModule.index",
"phoneServiceDisplay",
"addOnModules.addOnModule",
"networkLocation",
"requireDtmfReception",
"secureDirectoryUrl",
"addOnModules.addOnModule.model",
"ecKeySize",
"deviceTrustMode",
"mlppDomainId",
"requireThirdPartyRegistration",
"homeNetworkId",
"alwaysUsePrimeLine",
"idleUrl",
"proxyServerUrl",
"sshPwd",
"ringSettingIdleBlfAudibleAlert",
"builtInBridgeStatus",
"addOnModules",
"packetCaptureDuration",
"wifiHotspotProfile",
"AllowPresentationSharingUsingBfcp",
"traceFlag",
"featureControlPolicy",
"mlppIndicationStatus",
"requireOffPremiseLocation",
"packetCaptureMode",
"loadInformation",
"allowMraMode",
"sendGeoLocation",
"isProtected",
"subscribeCallingSearchSpaceName",
"preemption",
"rfc2833Disabled",
"addOnModules.addOnModule.loadInformation",
"hlogStatus",
"upgradeFinishTime",
"certificateOperation",
"sshUserId",
"allowiXApplicableMedia",
"hotlineDevice",
"dndRingSetting",
"protocolSide",
"commonPhoneConfigName",
"idleTimeout",
"remoteDevice",
"mtpPreferedCodec",
"addOnModules__addOnModule__loadInformation",
"enableActivationID",
"isDualMode",
"dialRulesName"
],
"SupportsActivationCode": false,
"SecurityProfile": [
"Universal Device Template - Security Profile - Encrypted - Device_TFTP",
"Universal Device Template - Security Profile - Encrypted",
"Universal Device Template - Security Profile - Authenticated",
"Universal Device Template - Security Profile - Non-Secure",
"Universal Device Template - Security Profile - Encrypted EC preferred",
"Carrier-integrated Mobile - Standard SIP Non-Secure Profile"
]
}
],
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "61b13418eadb826afd7ce3b2",
"meta": {
"tags": [],
"cached": true,
"title": "Carrier-integrated Mobile",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f7ceadb826afd7b9861",
"href": "/api/v0/data/CallManager/61b12f7ceadb826afd7b9861"
}
],
"self": [
{
"pkid": "61b13418eadb826afd7ce3b2",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/61b13418eadb826afd7ce3b2/?model_type=device/cucm/PhoneType",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/PhoneType/61b13418eadb826afd7ce3b2/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/PhoneType",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b13418eadb826afd7ce3b2"
],
"summary_attrs": [
{
"name": "PhoneType",
"title": "Phone Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"PhoneNameExample": "KHq",
"hierarchy": "61b12edfeadb826afd7b715a",
"PhoneNameFormat": "^[0-9a-zA-Z]{1,15}$",
"PhoneType": "Carrier-integrated Mobile",
"PhoneNamePrefix": "",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"ProtocolTemplates": [
{
"PBT": [
"Standard Carrier-integrated Mobile"
],
"Protocol": "SIP",
"SupportedFeatures": [
"Automated Alternate Routing (AAR)",
"Call Waiting",
"Connected Transfer and Conference",
"Digest authentication support",
"Do Not Disturb",
"Dual-Mode",
"Enhanced Message Waiting Indicator",
"Has phone templates",
"Hold Reversion",
"Localization",
"Mobility",
"Multiple Call Display",
"Music On Hold",
"Network Hold",
"Presence Subscription",
"Privacy",
"Record",
"SIP TCP Support",
"Shared Line Appearance",
"Specify Types of TFTP Config Files",
"Use Generic Icon",
"User Hold",
"Virtual Private Network Client"
],
"VendorConfig": "{}",
"ExcludedSchemaKeys": [
"directoryUrl",
"protocol",
"secureInformationUrl",
"secureServicesUrl",
"authenticationUrl",
"authenticationMode",
"softkeyTemplateName",
"keyOrder",
"defaultProfileName",
"alwaysUsePrimeLineForVoiceMessage",
"enableCallRoutingToRdWhenNoneIsActive",
"mraServiceDomain",
"allowCtiControlFlag",
"useTrustedRelayPoint",
"singleButtonBarge",
"messagesUrl",
"enableExtensionMobility",
"authenticationString",
"commonDeviceConfigName",
"secureIdleUrl",
"earlyOfferSupportForVoiceCall",
"informationUrl",
"secureAuthenticationUrl",
"blockIncomingCallsWhenRoaming",
"ringSettingBusyBlfAudibleAlert",
"secureMessageUrl",
"msisdn",
"phoneSuite",
"geoLocationName",
"deviceMobilityMode",
"joinAcrossLines",
"outboundCallRollover",
"primaryPhoneName",
"retryVideoCallAsAudio",
"wirelessLanProfileGroup",
"geoLocationFilterName",
"addOnModules.addOnModule.index",
"phoneServiceDisplay",
"addOnModules.addOnModule",
"networkLocation",
"requireDtmfReception",
"secureDirectoryUrl",
"addOnModules.addOnModule.model",
"ecKeySize",
"deviceTrustMode",
"mlppDomainId",
"requireThirdPartyRegistration",
"homeNetworkId",
"alwaysUsePrimeLine",
"idleUrl",
"proxyServerUrl",
"sshPwd",
"ringSettingIdleBlfAudibleAlert",
"builtInBridgeStatus",
"addOnModules",
"packetCaptureDuration",
"wifiHotspotProfile",
"AllowPresentationSharingUsingBfcp",
"traceFlag",
"featureControlPolicy",
"mlppIndicationStatus",
"requireOffPremiseLocation",
"packetCaptureMode",
"loadInformation",
"allowMraMode",
"sendGeoLocation",
"isProtected",
"subscribeCallingSearchSpaceName",
"preemption",
"rfc2833Disabled",
"addOnModules.addOnModule.loadInformation",
"hlogStatus",
"upgradeFinishTime",
"certificateOperation",
"sshUserId",
"allowiXApplicableMedia",
"hotlineDevice",
"dndRingSetting",
"protocolSide",
"commonPhoneConfigName",
"idleTimeout",
"remoteDevice",
"mtpPreferedCodec",
"addOnModules__addOnModule__loadInformation",
"enableActivationID",
"isDualMode",
"dialRulesName"
],
"SupportsActivationCode": false,
"SecurityProfile": [
"Universal Device Template - Security Profile - Encrypted - Device_TFTP",
"Universal Device Template - Security Profile - Encrypted",
"Universal Device Template - Security Profile - Authenticated",
"Universal Device Template - Security Profile - Non-Secure",
"Universal Device Template - Security Profile - Encrypted EC preferred",
"Carrier-integrated Mobile - Standard SIP Non-Secure Profile"
]
}
],
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "61b131f0eadb826afd7c6539",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Carrier-integrated Mobile",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"self": [
{
"pkid": "61b131f0eadb826afd7c6539",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f01eadb826afd7b7a24",
"href": "/api/v0/data/CallManager/61b12f01eadb826afd7b7a24"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b131f0eadb826afd7c6539/?hierarchy=[hierarchy]&model_type=device/cucm/PhoneType",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/PhoneType/61b131f0eadb826afd7c6539/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/PhoneType",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b131f0eadb826afd7c6539"
],
"summary_attrs": [
{
"name": "PhoneType",
"title": "Phone Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"PhoneNameFormat": "^[0-9a-zA-Z]{1,15}$",
"ProtocolTemplates": [
{
"PBT": [
"Standard Carrier-integrated Mobile"
],
"Protocol": "SIP",
"SupportedFeatures": [
"Automated Alternate Routing (AAR)",
"Call Waiting",
"Connected Transfer and Conference",
"Digest authentication support",
"Do Not Disturb",
"Dual-Mode",
"Enhanced Message Waiting Indicator",
"Has phone templates",
"Hold Reversion",
"Localization",
"Mobility",
"Multiple Call Display",
"Music On Hold",
"Network Hold",
"Presence Subscription",
"Privacy",
"Record",
"SIP TCP Support",
"Shared Line Appearance",
"Specify Types of TFTP Config Files",
"Use Generic Icon",
"User Hold",
"Virtual Private Network Client"
],
"VendorConfig": "{}",
"ExcludedSchemaKeys": [
"directoryUrl",
"protocol",
"secureInformationUrl",
"secureServicesUrl",
"authenticationUrl",
"authenticationMode",
"softkeyTemplateName",
"keyOrder",
"defaultProfileName",
"alwaysUsePrimeLineForVoiceMessage",
"enableCallRoutingToRdWhenNoneIsActive",
"allowCtiControlFlag",
"useTrustedRelayPoint",
"singleButtonBarge",
"messagesUrl",
"enableExtensionMobility",
"authenticationString",
"commonDeviceConfigName",
"secureIdleUrl",
"earlyOfferSupportForVoiceCall",
"informationUrl",
"secureAuthenticationUrl",
"blockIncomingCallsWhenRoaming",
"ringSettingBusyBlfAudibleAlert",
"secureMessageUrl",
"msisdn",
"phoneSuite",
"geoLocationName",
"deviceMobilityMode",
"joinAcrossLines",
"outboundCallRollover",
"primaryPhoneName",
"retryVideoCallAsAudio",
"wirelessLanProfileGroup",
"geoLocationFilterName",
"addOnModules.addOnModule.index",
"phoneServiceDisplay",
"addOnModules.addOnModule",
"networkLocation",
"requireDtmfReception",
"secureDirectoryUrl",
"addOnModules.addOnModule.model",
"ecKeySize",
"deviceTrustMode",
"mlppDomainId",
"requireThirdPartyRegistration",
"homeNetworkId",
"alwaysUsePrimeLine",
"idleUrl",
"proxyServerUrl",
"sshPwd",
"ringSettingIdleBlfAudibleAlert",
"builtInBridgeStatus",
"addOnModules",
"packetCaptureDuration",
"wifiHotspotProfile",
"AllowPresentationSharingUsingBfcp",
"traceFlag",
"featureControlPolicy",
"mlppIndicationStatus",
"requireOffPremiseLocation",
"packetCaptureMode",
"loadInformation",
"sendGeoLocation",
"isProtected",
"subscribeCallingSearchSpaceName",
"preemption",
"rfc2833Disabled",
"addOnModules.addOnModule.loadInformation",
"hlogStatus",
"upgradeFinishTime",
"certificateOperation",
"sshUserId",
"allowiXApplicableMedia",
"hotlineDevice",
"dndRingSetting",
"protocolSide",
"commonPhoneConfigName",
"idleTimeout",
"mtpPreferedCodec",
"addOnModules__addOnModule__loadInformation",
"remoteDevice",
"isDualMode",
"dialRulesName"
],
"SecurityProfile": [
"Universal Device Template - Security Profile - Encrypted - Device_TFTP",
"Universal Device Template - Security Profile - Encrypted",
"Universal Device Template - Security Profile - Authenticated",
"Universal Device Template - Security Profile - Non-Secure",
"Universal Device Template - Security Profile - Encrypted EC preferred",
"Carrier-integrated Mobile - Standard SIP Non-Secure Profile"
]
}
],
"PhoneType": "Carrier-integrated Mobile",
"PhoneNamePrefix": "",
"PhoneNameExample": "KHq"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/PhoneType. | GET | /api/device/cucm/PhoneType/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/PhoneType as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/PhoneType/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/PhoneType/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/PhoneType | 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/PhoneType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/PhoneType/[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/PhoneType and the JSON format can be used to import instances of device/cucm/PhoneType.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/PhoneType/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/PhoneType instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/PhoneType/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/PhoneType. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/PhoneType/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |