[Index]
Model ref.: device/cucm/HuntList
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": { "callManagerGroupName": { "description": "Choose a \n Cisco Unified Communications Manager Group from the drop-down list. The Hunt List registers to the first node in the \n Cisco Unified Communications Manager Group. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you choose a \n Cisco Unified Communications Manager group that has only one node that is configured, you receive a warning. To avoid this issue, choose a group that is configured with more than one node. \n \n \n ", "format": "uri", "minItems": 1, "title": "Cisco Unified Communications Manager Group", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/CallManagerGroup", "type": [ "string", "null" ], "target": "/api/device/cucm/CallManagerGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "description": { "description": "Enter a description to help you identify further details about the hunt list that do not fit into the name. ", "title": "Description", "minItems": 0, "required": false, "maxItems": 1, "type": "string" }, "routeListEnabled": { "description": "Check this check box to enable your hunt list immediately when you click Save. No system reset is required. ", "title": "Enable this Hunt List (change effective on Save; no reset required)", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "members": { "title": "Members", "minItems": 0, "required": false, "maxItems": 1, "type": [ "object", "null" ], "properties": { "member": { "name": "member", "title": "Member", "minItems": 0, "items": { "type": [ "object", "null" ], "properties": { "selectionOrder": { "name": "selectionOrder", "title": "Selection Order", "minItems": 1, "required": false, "maxItems": 1, "type": "integer" }, "lineGroupName": { "name": "lineGroupName", "title": "Line Group Name", "minItems": 1, "required": true, "maxItems": 1, "type": [ "string", "null" ] } } }, "required": false, "type": "array" } } }, "voiceMailUsage": { "description": "If this hunt list is to be used for voicemail, check this check box. If you this check box, the route list control process keeps a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one. ", "title": "For Voice Mail Usage", "minItems": 0, "required": false, "default": false, "maxItems": 1, "type": "boolean" }, "name": { "description": "The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each hunt list name is unique to the route plan. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your hunt lists. The CompanynameLocationCalltype format provides enough detail and is short enough so you can easily identify a hunt list. \n \n \n ", "title": "Name", "minItems": 1, "required": true, "maxItems": 1, "type": "string" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cucm/HuntList/add/ |
|
The GUI Add form of device/cucm/HuntList 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/HuntList | 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/HuntList/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/HuntList/[pkid1]", "/api/device/cucm/HuntList/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/HuntList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cucm/HuntList/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cucm/HuntList/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/HuntList/[pkid1]", "/api/v0/device/cucm/HuntList/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/HuntList/?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/HuntList |
|
{"hrefs": ["/api/device/cucm/HuntList/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/HuntList |
|
{"hrefs": ["/api/device/cucm/HuntList/[pkid1]", "/api/device/cucm/HuntList/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/HuntList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/HuntList/export/ |
|
{ "hrefs":["/api/device/cucm/HuntList/[pkid1]", "/api/device/cucm/HuntList/[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/HuntList and the JSON format can be used to import instances of device/cucm/HuntList.
GET http://[host-proxy]/api/device/cucm/HuntList/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/HuntList | POST | /api/device/cucm/HuntList/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/HuntList/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/HuntList/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cucm/HuntList/ |
|
The device/cucm/HuntList schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/HuntList instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "bulk_update_form", "add", "transform", "export", "export_bulkload_template" ], "pagination": { "direction": "asc", "order_by": "description", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cucm/HuntList/?skip=0&limit=3&order_by=description&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 1 }, "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/HuntList/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/HuntList/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cucm/HuntList/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/HuntList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/HuntList/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/HuntList/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cucm/HuntList/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cucm/HuntList/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cucm/HuntList/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/HuntList/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/HuntList/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cucm/HuntList", "model_specific_actions": [ "reset", "configuration_template", "field_display_policy", "help", "get", "clone", "move", "list", "update", "remove", "add", "export", "apply", "export_bulkload_template", "bulk_update_form" ], "summary_attrs": [ { "name": "description", "title": "Description" }, { "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": "60eee9efe04a4a001131ca46", "meta": { "tags": [], "cached": true, "title": "EKB-5166-HL", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "60eee9efe04a4a001131ca46", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/60eee9efe04a4a001131ca46/?model_type=device/cucm/HuntList", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/help", "method": "GET", "title": "Help" } }, { "apply": { "title": "Apply", "support_async": true, "method": "POST", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/+apply/", "class": "custom", "view": "/api/device/cucm/HuntList/+apply/schema/" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/purge/", "method": "POST", "title": "Purge" } }, { "reset": { "title": "Reset", "support_async": true, "method": "POST", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/+reset/", "class": "custom", "view": "/api/device/cucm/HuntList/+reset/schema/" } } ], "model_type": "device/cucm/HuntList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "60eee9efe04a4a001131ca46" ], "summary_attrs": [ { "name": "description", "title": "Description" }, { "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": { "callManagerGroupName": "ABG-CL1-PhonesGroup-Sub1-Sub2", "name": "EKB-5166-HL", "routeListEnabled": true, "members": { "member": [ { "selectionOrder": 1, "lineGroupName": "EKB-5166-LG" } ] }, "voiceMailUsage": false, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group" } } ] }
(Show the first instance)
{ "pkid": "60eee9efe04a4a001131ca46", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "EKB-5166-HL", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "60eee9efe04a4a001131ca46", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/" } ], "foreign_key": [], "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/60eee9efe04a4a001131ca46/?hierarchy=[hierarchy]&model_type=device/cucm/HuntList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "apply": { "title": "Apply", "support_async": true, "method": "POST", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/+apply/?hierarchy=[hierarchy]", "class": "custom", "view": "/api/device/cucm/HuntList/+apply/schema/?auth_token=[authtoken] } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } }, { "reset": { "title": "Reset", "support_async": true, "method": "POST", "href": "/api/device/cucm/HuntList/60eee9efe04a4a001131ca46/+reset/?hierarchy=[hierarchy]", "class": "custom", "view": "/api/device/cucm/HuntList/+reset/schema/?auth_token=[authtoken] } } ], "model_type": "device/cucm/HuntList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "60eee9efe04a4a001131ca46" ], "summary_attrs": [ { "name": "description", "title": "Description" }, { "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": { "voiceMailUsage": false, "callManagerGroupName": "ABG-CL1-PhonesGroup-Sub1-Sub2", "name": "EKB-5166-HL", "members": { "member": [ { "selectionOrder": 1, "lineGroupName": "EKB-5166-LG" } ] }, "routeListEnabled": true } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cucm/HuntList. | GET | /api/device/cucm/HuntList/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/HuntList as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cucm/HuntList/[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/HuntList/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/HuntList/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/HuntList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/HuntList | 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/HuntList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/HuntList/[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/HuntList and the JSON format can be used to import instances of device/cucm/HuntList.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cucm/HuntList/[pkid] | hierarchy=[hierarchy] | The device/cucm/HuntList instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cucm/HuntList/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/HuntList. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Apply | POST | /api/device/cucm/HuntList/[pkid]/+apply | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cucm/HuntList/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Reset | POST | /api/device/cucm/HuntList/[pkid]/+reset | hierarchy=[hierarchy] | If payload required: |