[Index]
Model ref.: device/cucm/DeviceProfileOptions
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": {
"deviceProfile": {
"name": "deviceProfile",
"title": "Device Profile",
"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"
},
"phoneTemplateName": {
"name": "phoneTemplateName",
"title": "Phone Template Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"alwaysUsePrimeLine": {
"name": "alwaysUsePrimeLine",
"title": "Always Use Prime Line",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"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"
},
"alwaysUsePrimeLineForVoiceMessage": {
"name": "alwaysUsePrimeLineForVoiceMessage",
"title": "Always Use Prime Line For Voice Message",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"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"
}
}
},
"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 or 2.",
"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": 2,
"type": "array"
}
},
"name": "addOnModules"
},
"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"
},
"mlppIndicationStatus": {
"description": "This setting only affects devices that support MLPP.",
"title": "Mlpp Indication Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "mlppIndicationStatus"
},
"product": {
"description": "Product ID string. read-only except when creating a device.",
"title": "Product",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"name": "product"
},
"userLocale": {
"name": "userLocale",
"title": "User Locale",
"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"
}
}
},
"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"
},
"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"
},
"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"
},
"softkeyTemplateName": {
"name": "softkeyTemplateName",
"title": "Softkey Template 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"
},
"callInfoPrivacyStatus": {
"name": "callInfoPrivacyStatus",
"title": "Call Info Privacy Status",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"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 is a shorthand method that refers to a particular directory number.",
"title": "Line Identifier",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {}
},
"required": false,
"type": "array",
"name": "lineIdentifier"
}
}
},
"loginUserId": {
"name": "loginUserId",
"title": "Login User Id",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"emccCallingSearchSpace": {
"name": "emccCallingSearchSpace",
"title": "Emcc Calling Search Space",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
}
}
}
}
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/DeviceProfileOptions/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/DeviceProfileOptions/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/DeviceProfileOptions/[pkid1]", "/api/v0/device/cucm/DeviceProfileOptions/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/DeviceProfileOptions/?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/DeviceProfileOptions |
|
{"hrefs": ["/api/device/cucm/DeviceProfileOptions/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/DeviceProfileOptions |
|
{"hrefs": ["/api/device/cucm/DeviceProfileOptions/[pkid1]", "/api/device/cucm/DeviceProfileOptions/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/DeviceProfileOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/DeviceProfileOptions/export/ |
|
{ "hrefs":["/api/device/cucm/DeviceProfileOptions/[pkid1]", "/api/device/cucm/DeviceProfileOptions/[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/DeviceProfileOptions and the JSON format can be used to import instances of device/cucm/DeviceProfileOptions.
GET http://[host-proxy]/api/device/cucm/DeviceProfileOptions/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/DeviceProfileOptions | POST | /api/device/cucm/DeviceProfileOptions/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/DeviceProfileOptions/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/DeviceProfileOptions/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/DeviceProfileOptions. | GET | /api/device/cucm/DeviceProfileOptions/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/DeviceProfileOptions as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/DeviceProfileOptions/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/DeviceProfileOptions/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/DeviceProfileOptions/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/DeviceProfileOptions | 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/DeviceProfileOptions; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/DeviceProfileOptions/[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/DeviceProfileOptions and the JSON format can be used to import instances of device/cucm/DeviceProfileOptions.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/DeviceProfileOptions/[pkid] | hierarchy=[hierarchy] | The device/cucm/DeviceProfileOptions instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/DeviceProfileOptions/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/DeviceProfileOptions. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/DeviceProfileOptions/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |