[Index]
Model ref.: device/cucm/PhoneButtonTemplate
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": { "buttons": { "description": "The list of buttons on this model of Phone.The feature and label of first button cannot be modified.", "title": "Buttons", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "button": { "name": "button", "title": "Button", "minItems": 0, "items": { "type": [ "object", "null" ], "properties": { "buttonNumber": { "name": "buttonNumber", "title": "Button Number", "minItems": 1, "required": true, "maxItems": 1, "type": "integer" }, "feature": { "description": "The feature invoked by this button.", "title": "Feature", "minItems": 1, "required": true, "choices": [ { "value": "Redial", "title": "Redial" }, { "value": "Speed Dial", "title": "Speed Dial" }, { "value": "Hold", "title": "Hold" }, { "value": "Transfer", "title": "Transfer" }, { "value": "Forward All", "title": "Forward All" }, { "value": "Display", "title": "Display" }, { "value": "Line", "title": "Line" }, { "value": "Chat", "title": "Chat" }, { "value": "Whiteboard", "title": "Whiteboard" }, { "value": "Application Sharing", "title": "Application Sharing" }, { "value": "File Transfer", "title": "File Transfer" }, { "value": "Video", "title": "Video" }, { "value": "Message Waiting", "title": "Message Waiting" }, { "value": "Answer/Release", "title": "Answer/Release" }, { "value": "Auto Answer", "title": "Auto Answer" }, { "value": "Settings", "title": "Settings" }, { "value": "Privacy", "title": "Privacy" }, { "value": "Service URL", "title": "Service URL" }, { "value": "Speed Dial BLF", "title": "Speed Dial BLF" }, { "value": "Call Park BLF", "title": "Call Park BLF" }, { "value": "Intercom", "title": "Intercom" }, { "value": "Malicious Call Identification", "title": "Malicious Call Identification" }, { "value": "Meet Me Conference", "title": "Meet Me Conference" }, { "value": "Conference", "title": "Conference" }, { "value": "Call Park", "title": "Call Park" }, { "value": "Call Pickup", "title": "Call Pickup" }, { "value": "Group Call Pickup", "title": "Group Call Pickup" }, { "value": "Mobility", "title": "Mobility" }, { "value": "Do Not Disturb", "title": "Do Not Disturb" }, { "value": "Conference List", "title": "Conference List" }, { "value": "Remove Last Participant", "title": "Remove Last Participant" }, { "value": "Quality Reporting Tool", "title": "Quality Reporting Tool" }, { "value": "CallBack", "title": "CallBack" }, { "value": "Other Pickup", "title": "Other Pickup" }, { "value": "Video Mode", "title": "Video Mode" }, { "value": "New Call", "title": "New Call" }, { "value": "End Call", "title": "End Call" }, { "value": "Hunt Group Logout", "title": "Hunt Group Logout" }, { "value": "All Calls", "title": "All Calls" }, { "value": "Answer Oldest", "title": "Answer Oldest" }, { "value": "Alerting Calls", "title": "Alerting Calls" }, { "value": "Queue Status", "title": "Queue Status" }, { "value": "Record", "title": "Record" }, { "value": "Services", "title": "Services" }, { "value": "Messages", "title": "Messages" }, { "value": "Directories", "title": "Directories" }, { "value": "Information", "title": "Information" }, { "value": "Application Menu", "title": "Application Menu" }, { "value": "Headset", "title": "Headset" }, { "value": "AEC", "title": "AEC" }, { "value": "None", "title": "None" } ], "maxItems": 1, "type": "string", "name": "feature" }, "label": { "description": "The label invoked by this button.", "title": "Label", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 50, "type": "string", "name": "label" } } }, "required": false, "type": "array" } } }, "name": { "description": "The template's name", "title": "Name", "minItems": 1, "required": true, "maxItems": 1, "type": "string" }, "basePhoneTemplateName": { "target": "/api/device/cucm/PhoneButtonTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 1, "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/PhoneButtonTemplate", "title": "Base Phone Template Name", "type": "string" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cucm/PhoneButtonTemplate/add/ |
|
The GUI Add form of device/cucm/PhoneButtonTemplate 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/PhoneButtonTemplate | 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/PhoneButtonTemplate/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/PhoneButtonTemplate/[pkid1]", "/api/device/cucm/PhoneButtonTemplate/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/PhoneButtonTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cucm/PhoneButtonTemplate/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cucm/PhoneButtonTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/PhoneButtonTemplate/[pkid1]", "/api/v0/device/cucm/PhoneButtonTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/PhoneButtonTemplate/?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/PhoneButtonTemplate |
|
{"hrefs": ["/api/device/cucm/PhoneButtonTemplate/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/PhoneButtonTemplate |
|
{"hrefs": ["/api/device/cucm/PhoneButtonTemplate/[pkid1]", "/api/device/cucm/PhoneButtonTemplate/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/PhoneButtonTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/PhoneButtonTemplate/export/ |
|
{ "hrefs":["/api/device/cucm/PhoneButtonTemplate/[pkid1]", "/api/device/cucm/PhoneButtonTemplate/[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/PhoneButtonTemplate and the JSON format can be used to import instances of device/cucm/PhoneButtonTemplate.
GET http://[host-proxy]/api/device/cucm/PhoneButtonTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/PhoneButtonTemplate | POST | /api/device/cucm/PhoneButtonTemplate/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/PhoneButtonTemplate/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/PhoneButtonTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cucm/PhoneButtonTemplate/ |
|
The device/cucm/PhoneButtonTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/PhoneButtonTemplate instances)
{ "operations": [ "field_display_policy", "configuration_template", "export_bulkload_template", "move", "transform", "export", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cucm/PhoneButtonTemplate/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 186 }, "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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cucm/PhoneButtonTemplate/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/PhoneButtonTemplate/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cucm/PhoneButtonTemplate/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/PhoneButtonTemplate", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/PhoneButtonTemplate/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/PhoneButtonTemplate/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cucm/PhoneButtonTemplate/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cucm/PhoneButtonTemplate/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cucm/PhoneButtonTemplate/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/PhoneButtonTemplate/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/PhoneButtonTemplate/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/PhoneButtonTemplate", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "bulk_update_form", "add", "export", "apply", "export_bulkload_template", "restart" ], "summary_attrs": [ { "name": "name", "title": "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": "5f3ae5cdce894e0012055d12", "meta": { "tags": [], "cached": true, "title": "Cisco DX650 SIP", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae5cdce894e0012055d12", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae5cdce894e0012055d12/?model_type=device/cucm/PhoneButtonTemplate", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/help", "method": "GET", "title": "Help" } }, { "apply": { "title": "Apply", "support_async": true, "method": "POST", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/+apply/", "class": "custom", "view": "/api/device/cucm/PhoneButtonTemplate/+apply/schema/" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/purge/", "method": "POST", "title": "Purge" } }, { "restart": { "title": "Restart", "support_async": true, "method": "POST", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/+restart/", "class": "custom", "view": "/api/device/cucm/PhoneButtonTemplate/+restart/schema/" } } ], "model_type": "device/cucm/PhoneButtonTemplate", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5cdce894e0012055d12" ], "summary_attrs": [ { "name": "name", "title": "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": { "name": "Cisco DX650 SIP", "hierarchy": "5f3ae552ce894e00120537fa", "buttons": { "button": [ { "buttonNumber": 1, "feature": "Line", "label": "Line1" }, { "buttonNumber": 2, "feature": "Line", "label": "Line2" }, { "buttonNumber": 4, "feature": "Speed Dial", "label": "Speed Dial2" }, { "buttonNumber": 5, "feature": "Speed Dial", "label": "Speed Dial3" }, { "buttonNumber": 6, "feature": "Speed Dial", "label": "Speed Dial4" }, { "buttonNumber": 7, "feature": "Speed Dial", "label": "Speed Dial5" }, { "buttonNumber": 8, "feature": "Speed Dial", "label": "Speed Dial6" }, { "buttonNumber": 9, "feature": "Speed Dial", "label": "Speed Dial7" }, { "buttonNumber": 10, "feature": "Speed Dial", "label": "Speed Dial8" }, { "buttonNumber": 11, "feature": "Speed Dial", "label": "Speed Dial9" }, { "buttonNumber": 12, "feature": "Speed Dial", "label": "Speed Dial10" }, { "buttonNumber": 13, "feature": "Speed Dial", "label": "Speed Dial11" }, { "buttonNumber": 14, "feature": "Speed Dial", "label": "Speed Dial12" }, { "buttonNumber": 15, "feature": "Speed Dial", "label": "Speed Dial13" }, { "buttonNumber": 3, "feature": "Redial", "label": "Redial" } ] }, "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3ae5bcce894e0012055a63", "meta": { "tags": [], "cached": true, "title": "Cisco DX70 SIP", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae5bcce894e0012055a63", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae5bcce894e0012055a63/?model_type=device/cucm/PhoneButtonTemplate", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/help", "title": "Help", "class": "help", "method": "GET" } }, { "apply": { "title": "Apply", "support_async": true, "class": "custom", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/+apply/", "method": "POST", "view": "/api/device/cucm/PhoneButtonTemplate/+apply/schema/" } }, { "purge": { "support_async": false, "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/purge/", "title": "Purge", "class": "purge", "method": "POST" } }, { "restart": { "title": "Restart", "support_async": true, "class": "custom", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5bcce894e0012055a63/+restart/", "method": "POST", "view": "/api/device/cucm/PhoneButtonTemplate/+restart/schema/" } } ], "model_type": "device/cucm/PhoneButtonTemplate", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5bcce894e0012055a63" ], "summary_attrs": [ { "name": "name", "title": "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": { "name": "Cisco DX70 SIP", "hierarchy": "5f3ae552ce894e00120537fa", "buttons": { "button": [ { "buttonNumber": 1, "feature": "Line", "label": "Line1" }, { "buttonNumber": 2, "feature": "Line", "label": "Line2" }, { "buttonNumber": 3, "feature": "Redial", "label": "Redial" }, { "buttonNumber": 4, "feature": "Speed Dial", "label": "Speed Dial1" }, { "buttonNumber": 5, "feature": "Speed Dial", "label": "Speed Dial2" }, { "buttonNumber": 6, "feature": "Speed Dial", "label": "Speed Dial3" }, { "buttonNumber": 7, "feature": "Speed Dial", "label": "Speed Dial4" }, { "buttonNumber": 8, "feature": "Speed Dial", "label": "Speed Dial5" }, { "buttonNumber": 9, "feature": "Speed Dial", "label": "Speed Dial6" }, { "buttonNumber": 10, "feature": "Speed Dial", "label": "Speed Dial7" }, { "buttonNumber": 11, "feature": "Speed Dial", "label": "Speed Dial8" }, { "buttonNumber": 12, "feature": "Speed Dial", "label": "Speed Dial9" }, { "buttonNumber": 13, "feature": "Speed Dial", "label": "Speed Dial10" }, { "buttonNumber": 14, "feature": "Speed Dial", "label": "Speed Dial11" }, { "buttonNumber": 15, "feature": "Speed Dial", "label": "Speed Dial12" } ] }, "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3ae5b9ce894e00120559be", "meta": { "tags": [], "cached": true, "title": "Cisco DX80 SIP", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae5b9ce894e00120559be", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/5f3ae5b9ce894e00120559be/?model_type=device/cucm/PhoneButtonTemplate", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/help", "class": "help", "title": "Help" } }, { "apply": { "title": "Apply", "support_async": true, "class": "custom", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/+apply/", "method": "POST", "view": "/api/device/cucm/PhoneButtonTemplate/+apply/schema/" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/purge/", "class": "purge", "title": "Purge" } }, { "restart": { "title": "Restart", "support_async": true, "class": "custom", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5b9ce894e00120559be/+restart/", "method": "POST", "view": "/api/device/cucm/PhoneButtonTemplate/+restart/schema/" } } ], "model_type": "device/cucm/PhoneButtonTemplate", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5b9ce894e00120559be" ], "summary_attrs": [ { "name": "name", "title": "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": { "name": "Cisco DX80 SIP", "hierarchy": "5f3ae552ce894e00120537fa", "buttons": { "button": [ { "buttonNumber": 1, "feature": "Line", "label": "Line1" }, { "buttonNumber": 2, "feature": "Line", "label": "Line2" }, { "buttonNumber": 3, "feature": "Redial", "label": "Redial" }, { "buttonNumber": 4, "feature": "Speed Dial", "label": "Speed Dial1" }, { "buttonNumber": 5, "feature": "Speed Dial", "label": "Speed Dial2" }, { "buttonNumber": 6, "feature": "Speed Dial", "label": "Speed Dial3" }, { "buttonNumber": 7, "feature": "Speed Dial", "label": "Speed Dial4" }, { "buttonNumber": 8, "feature": "Speed Dial", "label": "Speed Dial5" }, { "buttonNumber": 9, "feature": "Speed Dial", "label": "Speed Dial6" }, { "buttonNumber": 10, "feature": "Speed Dial", "label": "Speed Dial7" }, { "buttonNumber": 11, "feature": "Speed Dial", "label": "Speed Dial8" }, { "buttonNumber": 12, "feature": "Speed Dial", "label": "Speed Dial9" }, { "buttonNumber": 13, "feature": "Speed Dial", "label": "Speed Dial10" }, { "buttonNumber": 14, "feature": "Speed Dial", "label": "Speed Dial11" }, { "buttonNumber": 15, "feature": "Speed Dial", "label": "Speed Dial12" } ] }, "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group" } } ] }
(Show the first instance)
{ "pkid": "5f3ae5cdce894e0012055d12", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Cisco DX650 SIP", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3ae5cdce894e0012055d12", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae5cdce894e0012055d12/?hierarchy=[hierarchy]&model_type=device/cucm/PhoneButtonTemplate", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "apply": { "title": "Apply", "support_async": true, "method": "POST", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/+apply/?hierarchy=[hierarchy]", "class": "custom", "view": "/api/device/cucm/PhoneButtonTemplate/+apply/schema/?auth_token=[authtoken] } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } }, { "restart": { "title": "Restart", "support_async": true, "method": "POST", "href": "/api/device/cucm/PhoneButtonTemplate/5f3ae5cdce894e0012055d12/+restart/?hierarchy=[hierarchy]", "class": "custom", "view": "/api/device/cucm/PhoneButtonTemplate/+restart/schema/?auth_token=[authtoken] } } ], "model_type": "device/cucm/PhoneButtonTemplate", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5cdce894e0012055d12" ], "summary_attrs": [ { "name": "name", "title": "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": { "buttons": { "button": [ { "buttonNumber": 2, "feature": "Line", "label": "Line2" }, { "buttonNumber": 4, "feature": "Speed Dial", "label": "Speed Dial2" }, { "buttonNumber": 5, "feature": "Speed Dial", "label": "Speed Dial3" }, { "buttonNumber": 6, "feature": "Speed Dial", "label": "Speed Dial4" }, { "buttonNumber": 7, "feature": "Speed Dial", "label": "Speed Dial5" }, { "buttonNumber": 8, "feature": "Speed Dial", "label": "Speed Dial6" }, { "buttonNumber": 9, "feature": "Speed Dial", "label": "Speed Dial7" }, { "buttonNumber": 10, "feature": "Speed Dial", "label": "Speed Dial8" }, { "buttonNumber": 11, "feature": "Speed Dial", "label": "Speed Dial9" }, { "buttonNumber": 12, "feature": "Speed Dial", "label": "Speed Dial10" }, { "buttonNumber": 13, "feature": "Speed Dial", "label": "Speed Dial11" }, { "buttonNumber": 14, "feature": "Speed Dial", "label": "Speed Dial12" }, { "buttonNumber": 15, "feature": "Speed Dial", "label": "Speed Dial13" }, { "buttonNumber": 3, "feature": "Redial", "label": "Redial" } ] }, "name": "Cisco DX650 SIP" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cucm/PhoneButtonTemplate. | GET | /api/device/cucm/PhoneButtonTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/PhoneButtonTemplate as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cucm/PhoneButtonTemplate/[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/PhoneButtonTemplate/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/PhoneButtonTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/PhoneButtonTemplate/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/PhoneButtonTemplate | 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/PhoneButtonTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/PhoneButtonTemplate/[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/PhoneButtonTemplate and the JSON format can be used to import instances of device/cucm/PhoneButtonTemplate.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cucm/PhoneButtonTemplate/[pkid] | hierarchy=[hierarchy] | The device/cucm/PhoneButtonTemplate instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cucm/PhoneButtonTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/PhoneButtonTemplate. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Apply | POST | /api/device/cucm/PhoneButtonTemplate/[pkid]/+apply | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cucm/PhoneButtonTemplate/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Restart | POST | /api/device/cucm/PhoneButtonTemplate/[pkid]/+restart | hierarchy=[hierarchy] | If payload required: |