[Index]
This relation wraps the default CUCM Route List element to allow for targeted network device addition.
Model ref.: relation/HcsRouteListREL
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": {
"minItems": 1,
"required": true,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Call Manager Group Name"
},
"description": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Description"
},
"routeListEnabled": {
"title": "Route List Enabled",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"runOnEveryNode": {
"title": "Run On Every Node",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"networkDevice": {
"type": "object",
"properties": {
"nd": {
"is_password": false,
"description": "Select the network device for which you would like to add this element.",
"title": "Network Device",
"minItems": 0,
"required": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
],
"readonly": false,
"type": "string"
}
},
"title": "Network Device"
},
"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": {
"callingPartyNumberType": {
"name": "callingPartyNumberType",
"title": "Calling Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"useFullyQualifiedCallingPartyNumber": {
"name": "useFullyQualifiedCallingPartyNumber",
"title": "Use Fully Qualified Calling Party Number",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingPartyPrefixDigits": {
"name": "callingPartyPrefixDigits",
"title": "Calling Party Prefix Digits",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"calledPartyTransformationMask": {
"name": "calledPartyTransformationMask",
"title": "Called Party Transformation Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"selectionOrder": {
"name": "selectionOrder",
"title": "Selection Order",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer"
},
"callingPartyNumberingPlan": {
"name": "callingPartyNumberingPlan",
"title": "Calling Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"digitDiscardInstructionName": {
"name": "digitDiscardInstructionName",
"title": "Digit Discard Instruction Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"prefixDigitsOut": {
"name": "prefixDigitsOut",
"title": "Prefix Digits Out",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"calledPartyNumberType": {
"name": "calledPartyNumberType",
"title": "Called Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"routeGroupName": {
"name": "routeGroupName",
"title": "Route Group Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"callingPartyTransformationMask": {
"name": "callingPartyTransformationMask",
"title": "Calling Party Transformation Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"calledPartyNumberingPlan": {
"name": "calledPartyNumberingPlan",
"title": "Called Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
}
}
},
"required": false,
"type": "array"
}
}
},
"name": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Name"
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsRouteListREL/add/ |
|
The GUI Add form of relation/HcsRouteListREL 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/relation/HcsRouteListREL/ | 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/relation/HcsRouteListREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsRouteListREL/[pkid1]", "/api/relation/HcsRouteListREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsRouteListREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsRouteListREL |
|
{"hrefs": ["/api/relation/HcsRouteListREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsRouteListREL |
|
{"hrefs": ["/api/relation/HcsRouteListREL/[pkid1]", "/api/relation/HcsRouteListREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsRouteListREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsRouteListREL/export/ |
|
{ "hrefs":["/api/relation/HcsRouteListREL/[pkid1]", "/api/relation/HcsRouteListREL/[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 relation/HcsRouteListREL and the JSON format can be used to import instances of relation/HcsRouteListREL.
GET http://[host-proxy]/api/relation/HcsRouteListREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsRouteListREL | POST | /api/relation/HcsRouteListREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsRouteListREL/ |
|
The relation/HcsRouteListREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsRouteListREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsRouteListREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 71
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsRouteListREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsRouteListREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRouteListREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsRouteListREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRouteListREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsRouteListREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsRouteListREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRouteListREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsRouteListREL",
"model_specific_actions": [
"help",
"get",
"clone",
"move",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"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": "610a049be04a4a0014a58e5c",
"meta": {
"tags": [],
"cached": true,
"title": "AutoTest-RouteListOnCucm-2032",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "6109c094e04a4a00149d75a4",
"href": "/api/v0/data/CallManager/6109c094e04a4a00149d75a4"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "610a049be04a4a0014a58e5c",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/"
}
],
"parent": [
{
"pkid": "6109c228e04a4a00149dd97c",
"href": "/api/data/HierarchyNode/6109c228e04a4a00149dd97c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/610a049be04a4a0014a58e5c/?model_type=relation/HcsRouteListREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/help",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/+apply/",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/+reset/",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRouteListREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c228e04a4a00149dd97c",
"610a049be04a4a0014a58e5c"
],
"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": {
"callManagerGroupName": "Default",
"description": "This is hard coded for some reason",
"routeListEnabled": true,
"name": "AutoTest-RouteListOnCucm-2032",
"runOnEveryNode": false,
"members": null,
"hierarchy_friendly_name": "LOC001 (Site)",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.LOC001"
}
},
{
"pkid": "6109c139e04a4a00149d9a7d",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1-USAEmer-RL",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109c060e04a4a00149d6aa3",
"href": "/api/v0/data/CallManager/6109c060e04a4a00149d6aa3"
}
],
"self": [
{
"pkid": "6109c139e04a4a00149d9a7d",
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/"
}
],
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109c139e04a4a00149d9a7d/?model_type=relation/HcsRouteListREL",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"apply": {
"support_async": true,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/+apply/",
"title": "Apply",
"class": "custom",
"method": "POST"
}
},
{
"reset": {
"support_async": true,
"href": "/api/relation/HcsRouteListREL/6109c139e04a4a00149d9a7d/+reset/",
"title": "Reset",
"class": "custom",
"method": "POST"
}
}
],
"model_type": "relation/HcsRouteListREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c139e04a4a00149d9a7d"
],
"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": {
"callManagerGroupName": "Default",
"description": "USADP Emergency Route List",
"routeListEnabled": true,
"hierarchy": "6109bff5e04a4a00149d4e1d",
"name": "Cu1-USAEmer-RL",
"runOnEveryNode": true,
"members": null,
"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": "6109c6c1e04a4a00149ef072",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1-USAEmer-RL",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "6109c094e04a4a00149d75a4",
"href": "/api/v0/data/CallManager/6109c094e04a4a00149d75a4"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109c6c1e04a4a00149ef072",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/"
}
],
"parent": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/data/HierarchyNode/6109c040e04a4a00149d61cf"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/6109c6c1e04a4a00149ef072/?model_type=relation/HcsRouteListREL",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/help",
"class": "help",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"method": "POST",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/+apply/",
"class": "custom",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"method": "POST",
"href": "/api/relation/HcsRouteListREL/6109c6c1e04a4a00149ef072/+reset/",
"class": "custom",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRouteListREL",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c6c1e04a4a00149ef072"
],
"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": {
"callManagerGroupName": "Default",
"description": "USADP Emergency Route List",
"routeListEnabled": true,
"name": "Cu1-USAEmer-RL",
"runOnEveryNode": true,
"members": null,
"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"
}
}
]
}
(Show the first instance)
{
"pkid": "610a049be04a4a0014a58e5c",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "AutoTest-RouteListOnCucm-2032",
"business_key": {},
"schema_version": "2.2",
"references": {
"device": [
{
"pkid": "6109c094e04a4a00149d75a4",
"href": "/api/v0/data/CallManager/6109c094e04a4a00149d75a4"
}
],
"self": [
{
"pkid": "610a049be04a4a0014a58e5c",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/"
}
],
"children": [],
"parent": [
{
"pkid": "6109c228e04a4a00149dd97c",
"href": "/api/data/HierarchyNode/6109c228e04a4a00149dd97c"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/610a049be04a4a0014a58e5c/?hierarchy=[hierarchy]&model_type=relation/HcsRouteListREL",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"apply": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/+apply/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Apply"
}
},
{
"reset": {
"support_async": true,
"class": "custom",
"href": "/api/relation/HcsRouteListREL/610a049be04a4a0014a58e5c/+reset/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Reset"
}
}
],
"model_type": "relation/HcsRouteListREL",
"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": {
"callManagerGroupName": "Default",
"name": "AutoTest-RouteListOnCucm-2032",
"routeListEnabled": true,
"runOnEveryNode": false,
"members": null,
"description": "This is hard coded for some reason"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsRouteListREL. | GET | /api/relation/HcsRouteListREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsRouteListREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsRouteListREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsRouteListREL/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsRouteListREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsRouteListREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsRouteListREL | 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 relation/HcsRouteListREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsRouteListREL/[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 relation/HcsRouteListREL and the JSON format can be used to import instances of relation/HcsRouteListREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsRouteListREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsRouteListREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsRouteListREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsRouteListREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Apply | POST | /api/relation/HcsRouteListREL/[pkid]/+apply/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Reset | POST | /api/relation/HcsRouteListREL/[pkid]/+reset/ | hierarchy=[hierarchy] | If payload required: |