[Index]
This relation wraps the default CUCM Translation Pattern element to allow for targeted network device addition.
Model ref.: relation/HcsTransPatternREL
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": {
"pattern": {
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"null",
"string"
]
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"maxLength": 50
},
"usage": {
"description": "For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.",
"title": "Usage",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string",
"choices": [
{
"title": "CallPark",
"value": "CallPark"
},
{
"title": "Conference",
"value": "Conference"
},
{
"title": "Device",
"value": "Device"
},
{
"title": "Translation",
"value": "Translation"
},
{
"title": "Call Pick Up Group",
"value": "Call Pick Up Group"
},
{
"title": "Route",
"value": "Route"
},
{
"title": "Message Waiting",
"value": "Message Waiting"
},
{
"title": "Hunt Pilot",
"value": "Hunt Pilot"
},
{
"title": "Voice Mail Port",
"value": "Voice Mail Port"
},
{
"title": "Domain Routing",
"value": "Domain Routing"
},
{
"title": "IPAddress Routing",
"value": "IPAddress Routing"
},
{
"title": "Device template",
"value": "Device template"
},
{
"title": "Directed Call Park",
"value": "Directed Call Park"
},
{
"title": "Device Intercom",
"value": "Device Intercom"
},
{
"title": "Translation Intercom",
"value": "Translation Intercom"
},
{
"title": "Translation Calling Party Number",
"value": "Translation Calling Party Number"
},
{
"title": "Mobility Handoff",
"value": "Mobility Handoff"
},
{
"title": "Mobility Enterprise Feature Access",
"value": "Mobility Enterprise Feature Access"
},
{
"title": "Mobility IVR",
"value": "Mobility IVR"
},
{
"title": "Device Intercom Template",
"value": "Device Intercom Template"
},
{
"title": "Called Party Number Transformation",
"value": "Called Party Number Transformation"
},
{
"title": "Call Control Discovery Learned Pattern",
"value": "Call Control Discovery Learned Pattern"
},
{
"title": "Uri Routing",
"value": "Uri Routing"
},
{
"title": "ILS Learned Enterprise Number",
"value": "ILS Learned Enterprise Number"
},
{
"title": "ILS Learned E164 Number",
"value": "ILS Learned E164 Number"
},
{
"title": "ILS Learned Enterprise Numeric Pattern",
"value": "ILS Learned Enterprise Numeric Pattern"
},
{
"title": "ILS Learned E164 Numeric Pattern",
"value": "ILS Learned E164 Numeric Pattern"
},
{
"title": "Alternate Number",
"value": "Alternate Number"
},
{
"title": "ILS Learned URI",
"value": "ILS Learned URI"
},
{
"title": "ILS Learned PSTN Failover Rule",
"value": "ILS Learned PSTN Failover Rule"
},
{
"title": "ILS Imported E164 Number",
"value": "ILS Imported E164 Number"
},
{
"title": "Centralized Conference Number",
"value": "Centralized Conference Number"
},
{
"title": "Emergency Location ID Number",
"value": "Emergency Location ID Number"
}
]
},
"routePartitionName": {
"title": "Route Partition Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"blockEnable": {
"title": "Block Enable",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"calledPartyTransformationMask": {
"title": "Called Party Transformation Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"pattern": "^[0-9*#+X]{0,50}$",
"maxLength": 50
},
"callingPartyTransformationMask": {
"title": "Calling Party Transformation Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"pattern": "^[0-9*#+X]{0,50}$",
"maxLength": 50
},
"useCallingPartyPhoneMask": {
"title": "Use Calling Party Phone Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Off",
"value": "Off"
},
{
"title": "On",
"value": "On"
},
{
"title": "Default",
"value": "Default"
}
]
},
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"maxLength": 50,
"pattern": "^[0-9*#+]{0,50}$"
},
"dialPlanName": {
"title": "Dial Plan Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/DialPlan",
"choices": []
},
"digitDiscardInstructionName": {
"title": "Digit Discard Instruction Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string",
"format": "uri",
"target": "/api/device/cucm/DiscardDigitInstruction/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/DiscardDigitInstruction",
"choices": []
},
"patternUrgency": {
"title": "Pattern Urgency",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"prefixDigitsOut": {
"title": "Prefix Digits Out",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"pattern": "^[0-9*#+]{0,50}$",
"maxLength": 50
},
"routeFilterName": {
"title": "Route Filter Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/RouteFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/RouteFilter",
"choices": []
},
"callingLinePresentationBit": {
"title": "Calling Line Presentation Bit",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Default",
"value": "Default"
},
{
"title": "Allowed",
"value": "Allowed"
},
{
"title": "Restricted",
"value": "Restricted"
}
]
},
"callingNamePresentationBit": {
"title": "Calling Name Presentation Bit",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Default",
"value": "Default"
},
{
"title": "Allowed",
"value": "Allowed"
},
{
"title": "Restricted",
"value": "Restricted"
}
]
},
"connectedLinePresentationBit": {
"title": "Connected Line Presentation Bit",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Default",
"value": "Default"
},
{
"title": "Allowed",
"value": "Allowed"
},
{
"title": "Restricted",
"value": "Restricted"
}
]
},
"connectedNamePresentationBit": {
"title": "Connected Name Presentation Bit",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Default",
"value": "Default"
},
{
"title": "Allowed",
"value": "Allowed"
},
{
"title": "Restricted",
"value": "Restricted"
}
]
},
"patternPrecedence": {
"title": "Pattern Precedence",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Flash Override",
"value": "Flash Override"
},
{
"title": "Flash",
"value": "Flash"
},
{
"title": "Immediate",
"value": "Immediate"
},
{
"title": "Priority",
"value": "Priority"
},
{
"title": "Routine",
"value": "Routine"
},
{
"title": "Default",
"value": "Default"
},
{
"title": "Executive Override",
"value": "Executive Override"
}
]
},
"provideOutsideDialtone": {
"title": "Provide Outside Dialtone",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": true,
"type": "boolean"
},
"callingPartyNumberingPlan": {
"title": "Calling Party Numbering Plan",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Cisco CallManager",
"type": "string",
"choices": [
{
"title": "Cisco CallManager",
"value": "Cisco CallManager"
},
{
"title": "ISDN",
"value": "ISDN"
},
{
"title": "National Standard",
"value": "National Standard"
},
{
"title": "Private",
"value": "Private"
},
{
"title": "Unknown",
"value": "Unknown"
}
]
},
"callingPartyNumberType": {
"title": "Calling Party Number Type",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Cisco CallManager",
"type": "string",
"choices": [
{
"title": "Cisco CallManager",
"value": "Cisco CallManager"
},
{
"title": "Unknown",
"value": "Unknown"
},
{
"title": "National",
"value": "National"
},
{
"title": "International",
"value": "International"
},
{
"title": "Subscriber",
"value": "Subscriber"
}
]
},
"calledPartyNumberingPlan": {
"title": "Called Party Numbering Plan",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Cisco CallManager",
"type": "string",
"choices": [
{
"title": "Cisco CallManager",
"value": "Cisco CallManager"
},
{
"title": "ISDN",
"value": "ISDN"
},
{
"title": "National Standard",
"value": "National Standard"
},
{
"title": "Private",
"value": "Private"
},
{
"title": "Unknown",
"value": "Unknown"
}
]
},
"calledPartyNumberType": {
"title": "Called Party Number Type",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Cisco CallManager",
"type": "string",
"choices": [
{
"title": "Cisco CallManager",
"value": "Cisco CallManager"
},
{
"title": "Unknown",
"value": "Unknown"
},
{
"title": "National",
"value": "National"
},
{
"title": "International",
"value": "International"
},
{
"title": "Subscriber",
"value": "Subscriber"
}
]
},
"callingSearchSpaceName": {
"title": "Calling Search Space Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/Css",
"choices": []
},
"resourcePriorityNamespaceName": {
"title": "Resource Priority Namespace Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/ResourcePriorityNamespace/choices/?field=namespace&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "namespace",
"target_model_type": "device/cucm/ResourcePriorityNamespace",
"choices": []
},
"routeNextHopByCgpn": {
"title": "Route Next Hop By Cgpn",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"routeClass": {
"title": "Route Class",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "Default",
"type": "string",
"choices": [
{
"title": "Default",
"value": "Default"
},
{
"title": "Voice",
"value": "Voice"
},
{
"title": "Data",
"value": "Data"
},
{
"title": "Satellite Avoidance",
"value": "Satellite Avoidance"
},
{
"title": "Hotline Voice",
"value": "Hotline Voice"
},
{
"title": "Hotline Data",
"value": "Hotline Data"
}
]
},
"callInterceptProfileName": {
"title": "Call Intercept Profile Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"format": "uri",
"target": "/api/device/cucm/ExternalCallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "device/cucm/ExternalCallControlProfile",
"choices": []
},
"releaseClause": {
"title": "Release Clause",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": "No Error",
"type": "string",
"choices": [
{
"title": "No Error",
"value": "No Error"
},
{
"title": "Unallocated Number",
"value": "Unallocated Number"
},
{
"title": "Call Rejected",
"value": "Call Rejected"
},
{
"title": "Number Changed",
"value": "Number Changed"
},
{
"title": "Invalid Number Format",
"value": "Invalid Number Format"
},
{
"title": "Precedence Level Exceeded",
"value": "Precedence Level Exceeded"
}
]
},
"useOriginatorCss": {
"title": "Use Originator Css",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"dontWaitForIDTOnSubsequentHops": {
"title": "Dont Wait For IDT On Subsequent Hops",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"isEmergencyServiceNumber": {
"title": "Is Emergency Service Number",
"minItems": 0,
"required": false,
"maxItems": 1,
"default": false,
"type": "boolean"
},
"networkDevice": {
"title": "Network Device",
"type": "object",
"properties": {
"nd": {
"title": "Network Device",
"description": "Select the network device for which you would like to add this element.",
"type": "string",
"minItems": 0,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false,
"choices": [
{
"value": " ",
"title": " "
}
]
}
}
}
},
"schema_version": "2.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsTransPatternREL/add/ |
|
The GUI Add form of relation/HcsTransPatternREL 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/HcsTransPatternREL | 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/HcsTransPatternREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsTransPatternREL/[pkid1]", "/api/relation/HcsTransPatternREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsTransPatternREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsTransPatternREL |
|
{"hrefs": ["/api/relation/HcsTransPatternREL/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsTransPatternREL |
|
{"hrefs": ["/api/relation/HcsTransPatternREL/[pkid1]", "/api/relation/HcsTransPatternREL/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsTransPatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsTransPatternREL/export/ |
|
{ "hrefs":["/api/relation/HcsTransPatternREL/[pkid1]", "/api/relation/HcsTransPatternREL/[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/HcsTransPatternREL and the JSON format can be used to import instances of relation/HcsTransPatternREL.
GET http://[host-proxy]/api/relation/HcsTransPatternREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsTransPatternREL | POST | /api/relation/HcsTransPatternREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsTransPatternREL/ |
|
The relation/HcsTransPatternREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsTransPatternREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 198,
"total_limit": null,
"order_by": "pattern",
"direction": "asc",
"current": "/api/relation/HcsTransPatternREL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=down"
},
"operations": [
"export",
"help",
"update",
"bulk_update",
"get",
"move",
"remove",
"list",
"configuration_template",
"export_bulkload_template",
"clone",
"field_display_policy",
"add"
],
"meta": {
"model_type": "relation/HcsTransPatternREL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "isEmergencyServiceNumber",
"title": "Is Emergency Service Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsTransPatternREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"export",
"help",
"update",
"get",
"move",
"remove",
"list",
"export_bulkload_template",
"clone",
"add"
],
"schema_version": "2.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsTransPatternREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsTransPatternREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsTransPatternREL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsTransPatternREL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HcsTransPatternREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsTransPatternREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsTransPatternREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"callingPartyPrefixDigits": null,
"hierarchy": "5df0b66bce894e001275a913",
"patternUrgency": true,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-IngressCCServer-PT",
"releaseClause": "No Error",
"description": "CC Translation Pattern for Cu1-CC15",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "!",
"patternPrecedence": "Default",
"callingSearchSpaceName": "Cu1-ISR-CSS",
"prefixDigitsOut": null,
"usage": "Translation",
"calledPartyNumberingPlan": "Cisco CallManager",
"dontWaitForIDTOnSubsequentHops": false,
"connectedNamePresentationBit": "Default",
"blockEnable": false,
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"useOriginatorCss": false,
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Default",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"isEmergencyServiceNumber": false,
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsTransPatternREL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "isEmergencyServiceNumber",
"title": "Is Emergency Service Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "!",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/",
"pkid": "61f121c1ef11f0522b5f8197"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"61f121c1ef11f0522b5f8197"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/61f121c1ef11f0522b5f8197/?model_type=relation/HcsTransPatternREL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "61f121c1ef11f0522b5f8197"
},
{
"data": {
"callingPartyPrefixDigits": null,
"patternUrgency": true,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-noFONet-PT",
"releaseClause": "Call Rejected",
"description": "Stop 2nd Stg EmerNum being Dailled",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "**004!",
"patternPrecedence": "Default",
"callingSearchSpaceName": "Cu1-ANumAnaly-CSS",
"prefixDigitsOut": null,
"usage": "Translation",
"calledPartyNumberingPlan": "Cisco CallManager",
"dontWaitForIDTOnSubsequentHops": true,
"connectedNamePresentationBit": "Default",
"blockEnable": true,
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"useOriginatorCss": false,
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"isEmergencyServiceNumber": false,
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsTransPatternREL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "isEmergencyServiceNumber",
"title": "Is Emergency Service Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "**004!",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/",
"pkid": "5df0b862ce894e0012761ddf"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b862ce894e0012761ddf"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5df0b862ce894e0012761ddf/?model_type=relation/HcsTransPatternREL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsTransPatternREL/5df0b862ce894e0012761ddf/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b862ce894e0012761ddf"
},
{
"data": {
"callingPartyPrefixDigits": null,
"patternUrgency": true,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-FONet-PT",
"releaseClause": "Call Rejected",
"description": "Stop 2nd Stg EmerNum being Dailled",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "**004!",
"patternPrecedence": "Default",
"callingSearchSpaceName": "Cu1-ANumAnaly-CSS",
"prefixDigitsOut": null,
"usage": "Translation",
"calledPartyNumberingPlan": "Cisco CallManager",
"dontWaitForIDTOnSubsequentHops": true,
"connectedNamePresentationBit": "Default",
"blockEnable": true,
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"useOriginatorCss": false,
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"isEmergencyServiceNumber": false,
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "relation/HcsTransPatternREL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "isEmergencyServiceNumber",
"title": "Is Emergency Service Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "**004!",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/",
"pkid": "5df0b867ce894e0012761eb1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b338ce894e001275535c",
"5df0b3a3ce894e0012756904",
"5df0b66bce894e001275a913",
"5df0b867ce894e0012761eb1"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5df0b867ce894e0012761eb1/?model_type=relation/HcsTransPatternREL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsTransPatternREL/5df0b867ce894e0012761eb1/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b867ce894e0012761eb1"
}
]
}
(Show the first instance)
{
"data": {
"callingPartyPrefixDigits": null,
"patternUrgency": true,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-IngressCCServer-PT",
"releaseClause": "No Error",
"description": "CC Translation Pattern for Cu1-CC15",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "!",
"patternPrecedence": "Default",
"callingSearchSpaceName": "Cu1-ISR-CSS",
"prefixDigitsOut": null,
"usage": "Translation",
"calledPartyNumberingPlan": "Cisco CallManager",
"dontWaitForIDTOnSubsequentHops": false,
"connectedNamePresentationBit": "Default",
"blockEnable": false,
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"useOriginatorCss": false,
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Default",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"isEmergencyServiceNumber": false,
"callingLinePresentationBit": "Default"
},
"meta": {
"model_type": "relation/HcsTransPatternREL",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "isEmergencyServiceNumber",
"title": "Is Emergency Service Number"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "!",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5df0b693ce894e001275c115",
"pkid": "5df0b693ce894e001275c115"
}
],
"children": [],
"parent": [
{
"pkid": "5df0b66bce894e001275a913",
"href": "/api/data/HierarchyNode/5df0b66bce894e001275a913"
}
],
"self": [
{
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/",
"pkid": "61f121c1ef11f0522b5f8197"
}
]
},
"schema_version": "2.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/61f121c1ef11f0522b5f8197/?hierarchy=[hierarchy]&model_type=relation/HcsTransPatternREL",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsTransPatternREL/61f121c1ef11f0522b5f8197/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "61f121c1ef11f0522b5f8197"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsTransPatternREL. | GET | /api/relation/HcsTransPatternREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsTransPatternREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsTransPatternREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsTransPatternREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsTransPatternREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsTransPatternREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsTransPatternREL | 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/HcsTransPatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsTransPatternREL/[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/HcsTransPatternREL and the JSON format can be used to import instances of relation/HcsTransPatternREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsTransPatternREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsTransPatternREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsTransPatternREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsTransPatternREL. |