[Index]
Model ref.: device/cucm/AudioCodecPreferenceList
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": { "codecsInList": { "title": "Codecs In List", "minItems": 1, "required": true, "maxItems": 1, "type": [ "object", "null" ], "properties": { "codecNames": { "name": "codecNames", "title": "Codec Names", "minItems": 1, "items": { "type": "string" }, "required": true, "maxItems": 31, "type": "array" } } }, "name": { "minItems": 1, "required": true, "type": "string", "maxItems": 1, "title": "Name" }, "description": { "minItems": 1, "required": true, "type": "string", "maxItems": 1, "title": "Description" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cucm/AudioCodecPreferenceList/add/ |
|
The GUI Add form of device/cucm/AudioCodecPreferenceList 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/AudioCodecPreferenceList/ | 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/AudioCodecPreferenceList/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/AudioCodecPreferenceList/[pkid1]", "/api/device/cucm/AudioCodecPreferenceList/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/AudioCodecPreferenceList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cucm/AudioCodecPreferenceList/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cucm/AudioCodecPreferenceList/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/AudioCodecPreferenceList/[pkid1]", "/api/v0/device/cucm/AudioCodecPreferenceList/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/AudioCodecPreferenceList/?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/AudioCodecPreferenceList |
|
{"hrefs": ["/api/device/cucm/AudioCodecPreferenceList/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/AudioCodecPreferenceList |
|
{"hrefs": ["/api/device/cucm/AudioCodecPreferenceList/[pkid1]", "/api/device/cucm/AudioCodecPreferenceList/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/AudioCodecPreferenceList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/AudioCodecPreferenceList/export/ |
|
{ "hrefs":["/api/device/cucm/AudioCodecPreferenceList/[pkid1]", "/api/device/cucm/AudioCodecPreferenceList/[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/AudioCodecPreferenceList and the JSON format can be used to import instances of device/cucm/AudioCodecPreferenceList.
GET http://[host-proxy]/api/device/cucm/AudioCodecPreferenceList/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/AudioCodecPreferenceList | POST | /api/device/cucm/AudioCodecPreferenceList/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/AudioCodecPreferenceList/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/AudioCodecPreferenceList/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cucm/AudioCodecPreferenceList/ |
|
The device/cucm/AudioCodecPreferenceList schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/AudioCodecPreferenceList instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "move", "list", "update", "remove", "transform", "add", "export", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cucm/AudioCodecPreferenceList/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 9 }, "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/AudioCodecPreferenceList/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/AudioCodecPreferenceList/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cucm/AudioCodecPreferenceList/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/AudioCodecPreferenceList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/AudioCodecPreferenceList/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/AudioCodecPreferenceList/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cucm/AudioCodecPreferenceList/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cucm/AudioCodecPreferenceList/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cucm/AudioCodecPreferenceList/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/AudioCodecPreferenceList/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/AudioCodecPreferenceList/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/AudioCodecPreferenceList", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "add", "export", "export_bulkload_template", "bulk_update_form" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": "63054d05c46e74b4687bed20", "meta": { "tags": [], "cached": true, "title": "Factory Default lossy", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "63054c77c46e74b4687bd11b", "href": "/api/v0/data/CallManager/63054c77c46e74b4687bd11b" } ], "self": [ { "pkid": "63054d05c46e74b4687bed20", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/" } ], "parent": [ { "pkid": "63054bfdc46e74b4687bb868", "href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/63054d05c46e74b4687bed20/?model_type=device/cucm/AudioCodecPreferenceList", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/AudioCodecPreferenceList", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054d05c46e74b4687bed20" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "codecsInList": { "codecNames": [ "OPUS (6k-510k)", "MP4A-LATM 128k", "AAC-LD (MP4A Generic)", "MP4A-LATM 64k", "MP4A-LATM 56k", "L16 256k", "MP4A-LATM 48k", "ISAC 32k", "AMR-WB (7k-24k)", "MP4A-LATM 32k", "G.722 64k", "G.722.1 32k", "G.722 56k", "G.722.1 24k", "G.722 48k", "MP4A-LATM 24k", "G.711 U-Law 64k", "G.711 A-Law 64k", "G.711 U-Law 56k", "G.711 A-Law 56k", "ILBC 16k", "G.728 16k", "AMR (5k-13k)", "GSM Enhanced Full Rate 13k", "GSM Full Rate 13k", "G.729b 8k", "G.729ab 8k", "G.729 8k", "G.729a 8k", "GSM Half Rate 6k", "G.723.1 7k" ] }, "name": "Factory Default lossy", "hierarchy": "63054bfdc46e74b4687bb868", "description": "Lossy Codec List", "hierarchy_friendly_name": "CS-P (Provider)", "summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P", "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "63054f86c46e74b4687ca724", "meta": { "tags": [], "cached": true, "title": "Factory Default lossy", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "63054ce5c46e74b4687be61f", "href": "/api/v0/data/CallManager/63054ce5c46e74b4687be61f" } ], "self": [ { "pkid": "63054f86c46e74b4687ca724", "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/" } ], "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/63054f86c46e74b4687ca724/?model_type=device/cucm/AudioCodecPreferenceList", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cucm/AudioCodecPreferenceList/63054f86c46e74b4687ca724/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cucm/AudioCodecPreferenceList", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "63054f86c46e74b4687ca724" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "codecsInList": { "codecNames": [ "OPUS (6k-510k)", "MP4A-LATM 128k", "AAC-LD (MP4A Generic)", "MP4A-LATM 64k", "MP4A-LATM 56k", "L16 256k", "MP4A-LATM 48k", "ISAC 32k", "AMR-WB (7k-24k)", "MP4A-LATM 32k", "G.722 64k", "G.722.1 32k", "G.722 56k", "G.722.1 24k", "G.722 48k", "MP4A-LATM 24k", "G.711 U-Law 64k", "G.711 A-Law 64k", "G.711 U-Law 56k", "G.711 A-Law 56k", "ILBC 16k", "G.728 16k", "AMR (5k-13k)", "GSM Enhanced Full Rate 13k", "GSM Full Rate 13k", "G.729b 8k", "G.729ab 8k", "G.729 8k", "G.729a 8k", "GSM Half Rate 6k", "G.723.1 7k" ] }, "name": "Factory Default lossy", "hierarchy": "63054c4fc46e74b4687bc91b", "description": "Lossy Codec List", "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "63054fedc46e74b4687cc448", "meta": { "tags": [], "cached": true, "title": "Factory Default lossy", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "63054d97c46e74b4687c0528", "href": "/api/v0/data/CallManager/63054d97c46e74b4687c0528" } ], "self": [ { "pkid": "63054fedc46e74b4687cc448", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/" } ], "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/63054fedc46e74b4687cc448/?model_type=device/cucm/AudioCodecPreferenceList", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cucm/AudioCodecPreferenceList/63054fedc46e74b4687cc448/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cucm/AudioCodecPreferenceList", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "63054fedc46e74b4687cc448" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "codecsInList": { "codecNames": [ "OPUS (6k-510k)", "MP4A-LATM 128k", "AAC-LD (MP4A Generic)", "MP4A-LATM 64k", "MP4A-LATM 56k", "L16 256k", "MP4A-LATM 48k", "ISAC 32k", "AMR-WB (7k-24k)", "MP4A-LATM 32k", "G.722 64k", "G.722.1 32k", "G.722 56k", "G.722.1 24k", "G.722 48k", "MP4A-LATM 24k", "G.711 U-Law 64k", "G.711 A-Law 64k", "G.711 U-Law 56k", "G.711 A-Law 56k", "ILBC 16k", "G.728 16k", "AMR (5k-13k)", "GSM Enhanced Full Rate 13k", "GSM Full Rate 13k", "G.729b 8k", "G.729ab 8k", "G.729 8k", "G.729a 8k", "GSM Half Rate 6k", "G.723.1 7k" ] }, "name": "Factory Default lossy", "hierarchy": "63054c4fc46e74b4687bc91b", "description": "Lossy Codec List", "hierarchy_friendly_name": "AAAGlobal (Customer)", "summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } } ] }
(Show the first instance)
{ "pkid": "63054d05c46e74b4687bed20", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Factory Default lossy", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "63054bfdc46e74b4687bb868", "href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868" } ], "self": [ { "pkid": "63054d05c46e74b4687bed20", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "63054c77c46e74b4687bd11b", "href": "/api/v0/data/CallManager/63054c77c46e74b4687bd11b" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/63054d05c46e74b4687bed20/?hierarchy=[hierarchy]&model_type=device/cucm/AudioCodecPreferenceList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/AudioCodecPreferenceList/63054d05c46e74b4687bed20/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/AudioCodecPreferenceList", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054d05c46e74b4687bed20" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "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": { "codecsInList": { "codecNames": [ "OPUS (6k-510k)", "MP4A-LATM 128k", "AAC-LD (MP4A Generic)", "MP4A-LATM 64k", "MP4A-LATM 56k", "L16 256k", "MP4A-LATM 48k", "ISAC 32k", "AMR-WB (7k-24k)", "MP4A-LATM 32k", "G.722 64k", "G.722.1 32k", "G.722 56k", "G.722.1 24k", "G.722 48k", "MP4A-LATM 24k", "G.711 U-Law 64k", "G.711 A-Law 64k", "G.711 U-Law 56k", "G.711 A-Law 56k", "ILBC 16k", "G.728 16k", "AMR (5k-13k)", "GSM Enhanced Full Rate 13k", "GSM Full Rate 13k", "G.729b 8k", "G.729ab 8k", "G.729 8k", "G.729a 8k", "GSM Half Rate 6k", "G.723.1 7k" ] }, "description": "Lossy Codec List", "name": "Factory Default lossy" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cucm/AudioCodecPreferenceList. | GET | /api/device/cucm/AudioCodecPreferenceList/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/AudioCodecPreferenceList as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cucm/AudioCodecPreferenceList/[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/AudioCodecPreferenceList/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/AudioCodecPreferenceList/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/AudioCodecPreferenceList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/AudioCodecPreferenceList | 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/AudioCodecPreferenceList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/AudioCodecPreferenceList/[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/AudioCodecPreferenceList and the JSON format can be used to import instances of device/cucm/AudioCodecPreferenceList.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cucm/AudioCodecPreferenceList/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/AudioCodecPreferenceList instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cucm/AudioCodecPreferenceList/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/AudioCodecPreferenceList. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cucm/AudioCodecPreferenceList/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |