[Index]
Model ref.: device/cucm/PhoneOptions
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": {
"return": {
"title": "Return",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "object",
"properties": {
"phone": {
"name": "phone",
"title": "Phone",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"protocol": {
"description": "Protocol option is read-only,except when creating a device.",
"title": "Protocol",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "protocol"
},
"alwaysUsePrimeLineForVoiceMessage": {
"name": "alwaysUsePrimeLineForVoiceMessage",
"title": "Always Use Prime Line For Voice Message",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"deviceTrustMode": {
"description": "This tag is valid only for TIP endpoints",
"title": "Device Trust Mode",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "deviceTrustMode"
},
"geoLocationFilterName": {
"name": "geoLocationFilterName",
"title": "Geo Location Filter Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"authenticationMode": {
"description": "authenticationMode can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Authentication Mode",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "authenticationMode"
},
"softkeyTemplateName": {
"name": "softkeyTemplateName",
"title": "Softkey Template Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"phoneServiceDisplay": {
"name": "phoneServiceDisplay",
"title": "Phone Service Display",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"keyOrder": {
"description": "keyOrder can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Key Order",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "keyOrder"
},
"userHoldMohAudioSourceId": {
"description": "This tag is not valid for H323Phone,H323trunk and SIPTrunk",
"title": "User Hold Moh Audio Source Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "userHoldMohAudioSourceId"
},
"defaultProfileName": {
"description": "The name of the default profile for this device.Not Nullable.",
"title": "Default Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "defaultProfileName"
},
"phoneTemplateName": {
"name": "phoneTemplateName",
"title": "Phone Template Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"sipProfileName": {
"description": "This Tag is valid only for SIP Phones and SIP Trunks",
"title": "Sip Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "sipProfileName"
},
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"title": "Calling Search Space Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"blfDirectedCallParks": {
"name": "blfDirectedCallParks",
"title": "Blf Directed Call Parks",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"blfDirectedCallPark": {
"name": "blfDirectedCallPark",
"title": "Blf Directed Call Park",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"directedCallParkId": {
"description": "Only the uuid attribute is read",
"title": "Directed Call Park Id",
"minItems": 0,
"pattern": "\\{........-....-....-....-............\\}",
"required": false,
"maxItems": 1,
"type": "string",
"name": "directedCallParkId"
},
"directedCallParkDnAndPartition": {
"name": "directedCallParkDnAndPartition",
"title": "Directed Call Park Dn And Partition",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"dnPattern": {
"name": "dnPattern",
"title": "Dn Pattern",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": "string"
}
}
}
}
},
"required": false,
"type": "array"
}
}
},
"alwaysUsePrimeLine": {
"name": "alwaysUsePrimeLine",
"title": "Always Use Prime Line",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"networkLocation": {
"description": "The new Device Destination for Trunk to Trunk Transfer and Drop Conference Feature is required for most gateways ,except FXS gateways and phones.Not Nullable.",
"title": "Network Location",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "networkLocation"
},
"ringSettingIdleBlfAudibleAlert": {
"name": "ringSettingIdleBlfAudibleAlert",
"title": "Ring Setting Idle Blf Audible Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"preemption": {
"description": "This setting only affects devices that support MLPP.",
"title": "Preemption",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "preemption"
},
"addOnModules": {
"description": "Additional modules attached to the Phone.There can be 0,1, 2 or 3.",
"title": "Add On Modules",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"addOnModule": {
"name": "addOnModule",
"title": "Add On Module",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"model": {
"description": "Model ID string.",
"title": "Model",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "model"
}
}
},
"required": false,
"maxItems": 3,
"type": "array"
}
},
"name": "addOnModules"
},
"useTrustedRelayPoint": {
"name": "useTrustedRelayPoint",
"title": "Use Trusted Relay Point",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"singleButtonBarge": {
"description": "This tag is valid only for devices that support SBB.",
"title": "Single Button Barge",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "singleButtonBarge"
},
"featureControlPolicy": {
"description": "This tag is valid only for RT Phones.",
"title": "Feature Control Policy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "featureControlPolicy"
},
"commonDeviceConfigName": {
"name": "commonDeviceConfigName",
"title": "Common Device Config Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"networkLocale": {
"name": "networkLocale",
"title": "Network Locale",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"mlppIndicationStatus": {
"description": "This setting only affects devices that support MLPP.",
"title": "Mlpp Indication Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "mlppIndicationStatus"
},
"mediaResourceListName": {
"name": "mediaResourceListName",
"title": "Media Resource List Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"packetCaptureMode": {
"name": "packetCaptureMode",
"title": "Packet Capture Mode",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"mraServiceDomain": {
"name": "mraServiceDomain",
"title": "Mra Service Domain",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"cgpnIngressDN": {
"name": "cgpnIngressDN",
"title": "Cgpn Ingress DN",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ringSettingBusyBlfAudibleAlert": {
"name": "ringSettingBusyBlfAudibleAlert",
"title": "Ring Setting Busy Blf Audible Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"product": {
"description": "Product ID string. read-only except when creating a device.",
"title": "Product",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "product"
},
"certificateOperation": {
"name": "certificateOperation",
"title": "Certificate Operation",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ownerUserName": {
"description": "Read-only for IP Phones.",
"title": "Owner User Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "ownerUserName"
},
"mtpPreferedCodec": {
"description": "This field is applicable only to SIP phones.",
"title": "Mtp Prefered Codec",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "mtpPreferedCodec"
},
"phoneSuite": {
"description": "If a blank tag is passed ,the value of the default is inserted into the database.",
"title": "Phone Suite",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "phoneSuite"
},
"subscribeCallingSearchSpaceName": {
"description": "Support for this tag has been removed for IMS phones from 9.0",
"title": "Subscribe Calling Search Space Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "subscribeCallingSearchSpaceName"
},
"userLocale": {
"name": "userLocale",
"title": "User Locale",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"dialRulesName": {
"name": "dialRulesName",
"title": "Dial Rules Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"geoLocationName": {
"name": "geoLocationName",
"title": "Geo Location Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"wifiHotspotProfile": {
"name": "wifiHotspotProfile",
"title": "Wifi Hotspot Profile",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"deviceMobilityMode": {
"description": "Specifies if the phone is configured for device mobility or not.",
"title": "Device Mobility Mode",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "deviceMobilityMode"
},
"builtInBridgeStatus": {
"name": "builtInBridgeStatus",
"title": "Built In Bridge Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"elinGroup": {
"name": "elinGroup",
"title": "Elin Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"joinAcrossLines": {
"description": "This tag is valid only for devices that support JAL..",
"title": "Join Across Lines",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "joinAcrossLines"
},
"services": {
"name": "services",
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"service": {
"name": "service",
"title": "Service",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"telecasterServiceName": {
"name": "telecasterServiceName",
"title": "Telecaster Service Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"outboundCallRollover": {
"description": "This tag is valid only for devices that Automatic Outbound Callrollover",
"title": "Outbound Call Rollover",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "outboundCallRollover"
},
"class": {
"description": "Class ID string. Class information is read-only except when creating a device.",
"title": "Class",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "class"
},
"primaryPhoneName": {
"name": "primaryPhoneName",
"title": "Primary Phone Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"dndOption": {
"description": "This tag is valid only for devices that support DND.",
"title": "Dnd Option",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "dndOption"
},
"securityProfileName": {
"name": "securityProfileName",
"title": "Security Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"presenceGroupName": {
"name": "presenceGroupName",
"title": "Presence Group Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/PresenceGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/PresenceGroup",
"choices": []
},
"dndRingSetting": {
"description": "This tag is valid only for devices that support DND.",
"title": "Dnd Ring Setting",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "dndRingSetting"
},
"callInfoPrivacyStatus": {
"name": "callInfoPrivacyStatus",
"title": "Call Info Privacy Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"rerouteCallingSearchSpaceName": {
"name": "rerouteCallingSearchSpaceName",
"title": "Reroute Calling Search Space Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"protocolSide": {
"description": "Side information is read-only except when creating a device",
"title": "Protocol Side",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "protocolSide"
},
"wirelessLanProfileGroup": {
"name": "wirelessLanProfileGroup",
"title": "Wireless Lan Profile Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"commonPhoneConfigName": {
"name": "commonPhoneConfigName",
"title": "Common Phone Config Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"networkHoldMohAudioSourceId": {
"description": "This tag is not valid for H323Phone,H323trunk and SIPTrunk",
"title": "Network Hold Moh Audio Source Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "networkHoldMohAudioSourceId"
},
"aarNeighborhoodName": {
"name": "aarNeighborhoodName",
"title": "Aar Neighborhood Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"locationName": {
"name": "locationName",
"title": "Location Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"cgpnTransformationCssName": {
"name": "cgpnTransformationCssName",
"title": "Cgpn Transformation Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"automatedAlternateRoutingCssName": {
"name": "automatedAlternateRoutingCssName",
"title": "Automated Alternate Routing Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"devicePoolName": {
"name": "devicePoolName",
"title": "Device Pool Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ecKeySize": {
"description": "ecKeySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Ec Key Size",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "ecKeySize"
},
"lines": {
"name": "lines",
"title": "Lines",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"line": {
"description": "An XLine is an entry in the DeviceNumPlanMap table. The actual directory number is referenced inside the XLine object by the \"dirn\" or \"dirnId\" element.",
"title": "Line",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"ringSettingActivePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Active Pickup Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "ringSettingActivePickupAlert"
},
"mwlPolicy": {
"name": "mwlPolicy",
"title": "Mwl Policy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"ringSettingIdlePickupAlert": {
"description": "Applicable only for IP Phones",
"title": "Ring Setting Idle Pickup Alert",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "ringSettingIdlePickupAlert"
},
"partitionUsage": {
"description": "This tag cannot be modified. It can only be specified in the add request.",
"title": "Partition Usage",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "partitionUsage"
},
"ringSetting": {
"name": "ringSetting",
"title": "Ring Setting",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"recordingFlag": {
"name": "recordingFlag",
"title": "Recording Flag",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"consecutiveRingSetting": {
"description": "Consecutive Rings Setting. Replaces the consective ring setting on IPPhone.",
"title": "Consecutive Ring Setting",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "consecutiveRingSetting"
},
"monitoringCssName": {
"name": "monitoringCssName",
"title": "Monitoring Css Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"recordingProfileName": {
"name": "recordingProfileName",
"title": "Recording Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"recordingMediaSource": {
"name": "recordingMediaSource",
"title": "Recording Media Source",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"audibleMwi": {
"description": "Not applicable for gatewayEndpointAnalogAccess and CiscoCatalyst600024PortFXSGateway",
"title": "Audible Mwi",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "audibleMwi"
},
"dirn": {
"description": "Only uuid attribute is returned in response",
"title": "Dirn",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"routePartitionName": {
"name": "routePartitionName",
"title": "Route Partition Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
},
"name": "dirn"
}
}
},
"required": false,
"type": "array",
"name": "line"
},
"lineIdentifier": {
"description": "The lineIdentifier cannot be used with AddLines and RemoveLines.This tag is valid only for lines tag",
"title": "Line Identifier",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {}
},
"required": false,
"type": "array",
"name": "lineIdentifier"
}
}
},
"mobilityUserIdName": {
"description": "The userid of the mobility user for this phone.Nullable.",
"title": "Mobility User Id Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "mobilityUserIdName"
},
"keySize": {
"description": "keySize can be updated only if certificateOperation field is Install/Upgrade,Delete or Troubleshoot.",
"title": "Key Size",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "keySize"
}
}
}
}
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/PhoneOptions/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/PhoneOptions/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/PhoneOptions/[pkid1]", "/api/v0/device/cucm/PhoneOptions/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/PhoneOptions/?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/PhoneOptions |
|
{"hrefs": ["/api/device/cucm/PhoneOptions/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/PhoneOptions |
|
{"hrefs": ["/api/device/cucm/PhoneOptions/[pkid1]", "/api/device/cucm/PhoneOptions/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/PhoneOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/PhoneOptions/export/ |
|
{ "hrefs":["/api/device/cucm/PhoneOptions/[pkid1]", "/api/device/cucm/PhoneOptions/[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/PhoneOptions and the JSON format can be used to import instances of device/cucm/PhoneOptions.
GET http://[host-proxy]/api/device/cucm/PhoneOptions/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/PhoneOptions | POST | /api/device/cucm/PhoneOptions/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/PhoneOptions/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/PhoneOptions/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/PhoneOptions. | GET | /api/device/cucm/PhoneOptions/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/PhoneOptions as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/PhoneOptions/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/PhoneOptions/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/PhoneOptions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/PhoneOptions | 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/PhoneOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/PhoneOptions/[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/PhoneOptions and the JSON format can be used to import instances of device/cucm/PhoneOptions.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/PhoneOptions/[pkid] | hierarchy=[hierarchy] | The device/cucm/PhoneOptions instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/PhoneOptions/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/PhoneOptions. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/PhoneOptions/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |