[Index]
Model ref.: device/cucm/TransPattern
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": {
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits",
"minItems": 0,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"prefixDigitsOut": {
"title": "Prefix Digits Out",
"minItems": 0,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"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"
},
"connectedLinePresentationBit": {
"title": "Connected Line Presentation Bit",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"title": "Route Partition Name",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"callingSearchSpaceName": {
"title": "Calling Search Space Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"blockEnable": {
"title": "Block Enable",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"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"
},
"provideOutsideDialtone": {
"title": "Provide Outside Dialtone",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"calledPartyTransformationMask": {
"title": "Called Party Transformation Mask",
"minItems": 0,
"pattern": "^[0-9*#+X]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"pattern": {
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"null",
"string"
]
},
"patternPrecedence": {
"title": "Pattern Precedence",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Flash Override",
"title": "Flash Override"
},
{
"value": "Flash",
"title": "Flash"
},
{
"value": "Immediate",
"title": "Immediate"
},
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Routine",
"title": "Routine"
},
{
"value": "Default",
"title": "Default"
},
{
"value": "Executive Override",
"title": "Executive Override"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"releaseClause": {
"title": "Release Clause",
"minItems": 0,
"required": false,
"choices": [
{
"value": "No Error",
"title": "No Error"
},
{
"value": "Unallocated Number",
"title": "Unallocated Number"
},
{
"value": "Call Rejected",
"title": "Call Rejected"
},
{
"value": "Number Changed",
"title": "Number Changed"
},
{
"value": "Invalid Number Format",
"title": "Invalid Number Format"
},
{
"value": "Precedence Level Exceeded",
"title": "Precedence Level Exceeded"
}
],
"default": "No Error",
"maxItems": 1,
"type": "string"
},
"callingLinePresentationBit": {
"title": "Calling Line Presentation Bit",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"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,
"choices": [
{
"value": "CallPark",
"title": "CallPark"
},
{
"value": "Conference",
"title": "Conference"
},
{
"value": "Device",
"title": "Device"
},
{
"value": "Translation",
"title": "Translation"
},
{
"value": "Call Pick Up Group",
"title": "Call Pick Up Group"
},
{
"value": "Route",
"title": "Route"
},
{
"value": "Message Waiting",
"title": "Message Waiting"
},
{
"value": "Hunt Pilot",
"title": "Hunt Pilot"
},
{
"value": "Voice Mail Port",
"title": "Voice Mail Port"
},
{
"value": "Domain Routing",
"title": "Domain Routing"
},
{
"value": "IPAddress Routing",
"title": "IPAddress Routing"
},
{
"value": "Device template",
"title": "Device template"
},
{
"value": "Directed Call Park",
"title": "Directed Call Park"
},
{
"value": "Device Intercom",
"title": "Device Intercom"
},
{
"value": "Translation Intercom",
"title": "Translation Intercom"
},
{
"value": "Translation Calling Party Number",
"title": "Translation Calling Party Number"
},
{
"value": "Mobility Handoff",
"title": "Mobility Handoff"
},
{
"value": "Mobility Enterprise Feature Access",
"title": "Mobility Enterprise Feature Access"
},
{
"value": "Mobility IVR",
"title": "Mobility IVR"
},
{
"value": "Device Intercom Template",
"title": "Device Intercom Template"
},
{
"value": "Called Party Number Transformation",
"title": "Called Party Number Transformation"
},
{
"value": "Call Control Discovery Learned Pattern",
"title": "Call Control Discovery Learned Pattern"
},
{
"value": "Uri Routing",
"title": "Uri Routing"
},
{
"value": "ILS Learned Enterprise Number",
"title": "ILS Learned Enterprise Number"
},
{
"value": "ILS Learned E164 Number",
"title": "ILS Learned E164 Number"
},
{
"value": "ILS Learned Enterprise Numeric Pattern",
"title": "ILS Learned Enterprise Numeric Pattern"
},
{
"value": "ILS Learned E164 Numeric Pattern",
"title": "ILS Learned E164 Numeric Pattern"
},
{
"value": "Alternate Number",
"title": "Alternate Number"
},
{
"value": "ILS Learned URI",
"title": "ILS Learned URI"
},
{
"value": "ILS Learned PSTN Failover Rule",
"title": "ILS Learned PSTN Failover Rule"
},
{
"value": "ILS Imported E164 Number",
"title": "ILS Imported E164 Number"
},
{
"value": "Centralized Conference Number",
"title": "Centralized Conference Number"
},
{
"value": "Emergency Location ID Number",
"title": "Emergency Location ID Number"
}
],
"maxItems": 1,
"type": "string"
},
"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"
},
"dontWaitForIDTOnSubsequentHops": {
"title": "Dont Wait For IDT On Subsequent Hops",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"connectedNamePresentationBit": {
"title": "Connected Name Presentation Bit",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": "string"
},
"routeClass": {
"title": "Route Class",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Voice",
"title": "Voice"
},
{
"value": "Data",
"title": "Data"
},
{
"value": "Satellite Avoidance",
"title": "Satellite Avoidance"
},
{
"value": "Hotline Voice",
"title": "Hotline Voice"
},
{
"value": "Hotline Data",
"title": "Hotline Data"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingNamePresentationBit": {
"title": "Calling Name Presentation Bit",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"dialPlanName": {
"title": "Dial Plan Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DialPlan",
"choices": []
},
"routeNextHopByCgpn": {
"title": "Route Next Hop By Cgpn",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"useOriginatorCss": {
"title": "Use Originator Css",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"digitDiscardInstructionName": {
"title": "Digit Discard Instruction Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": "string",
"target": "/api/device/cucm/DiscardDigitInstruction/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DiscardDigitInstruction",
"choices": []
},
"resourcePriorityNamespaceName": {
"title": "Resource Priority Namespace Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "namespace",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/ResourcePriorityNamespace/choices/?field=namespace&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/ResourcePriorityNamespace",
"choices": []
},
"useCallingPartyPhoneMask": {
"title": "Use Calling Party Phone Mask",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingPartyTransformationMask": {
"title": "Calling Party Transformation Mask",
"minItems": 0,
"pattern": "^[0-9*#+X]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"callInterceptProfileName": {
"title": "Call Intercept Profile Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/ExternalCallControlProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/ExternalCallControlProfile",
"choices": []
},
"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"
},
"routeFilterName": {
"title": "Route Filter Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RouteFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/RouteFilter",
"choices": []
},
"patternUrgency": {
"title": "Pattern Urgency",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"isEmergencyServiceNumber": {
"title": "Is Emergency Service Number",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/TransPattern/add/ |
|
The GUI Add form of device/cucm/TransPattern 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/TransPattern | 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/TransPattern/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/TransPattern/[pkid1]", "/api/device/cucm/TransPattern/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/TransPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/TransPattern/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/TransPattern/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/TransPattern/[pkid1]", "/api/v0/device/cucm/TransPattern/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/TransPattern/?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/TransPattern |
|
{"hrefs": ["/api/device/cucm/TransPattern/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/TransPattern |
|
{"hrefs": ["/api/device/cucm/TransPattern/[pkid1]", "/api/device/cucm/TransPattern/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/TransPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/TransPattern/export/ |
|
{ "hrefs":["/api/device/cucm/TransPattern/[pkid1]", "/api/device/cucm/TransPattern/[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/TransPattern and the JSON format can be used to import instances of device/cucm/TransPattern.
GET http://[host-proxy]/api/device/cucm/TransPattern/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/TransPattern | POST | /api/device/cucm/TransPattern/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/TransPattern/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/TransPattern/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/TransPattern/ |
|
The device/cucm/TransPattern schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/TransPattern instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 990,
"total_limit": null,
"order_by": "pattern",
"direction": "asc",
"current": "/api/device/cucm/TransPattern/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"configuration_template",
"export",
"bulk_update_form",
"transform",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "device/cucm/TransPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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": []
},
"model_specific_actions": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update_form",
"clone",
"export_bulkload_template",
"move"
],
"schema_version": "14.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/cucm/TransPattern/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/TransPattern/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cucm/TransPattern/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/TransPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cucm/TransPattern/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/device/cucm/TransPattern/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cucm/TransPattern/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cucm/TransPattern/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cucm/TransPattern/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/TransPattern/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/TransPattern/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"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",
"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": "device/cucm/TransPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/",
"pkid": "5ae8a280affa931cce399277"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a280affa931cce399277"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a280affa931cce399277/?model_type=device/cucm/TransPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a280affa931cce399277"
},
{
"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",
"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": "device/cucm/TransPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/",
"pkid": "5ae8a283affa931cce399359"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a283affa931cce399359"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a283affa931cce399359/?model_type=device/cucm/TransPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/TransPattern/5ae8a283affa931cce399359/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a283affa931cce399359"
},
{
"data": {
"callingPartyPrefixDigits": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-noFONet-PT",
"callingSearchSpaceName": "Cu1-ANumAnaly-CSS",
"blockEnable": true,
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "**004!",
"patternPrecedence": "Default",
"releaseClause": "Call Rejected",
"prefixDigitsOut": null,
"usage": "Translation",
"calledPartyNumberingPlan": "Cisco CallManager",
"dontWaitForIDTOnSubsequentHops": true,
"connectedNamePresentationBit": "Default",
"description": "Stop 2nd Stg EmerNum being Dailled",
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"useOriginatorCss": false,
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"patternUrgency": true,
"isEmergencyServiceNumber": false,
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.16, 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": "device/cucm/TransPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/",
"pkid": "5ae8a472affa931cce3a6051"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a472affa931cce3a6051"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a472affa931cce3a6051/?model_type=device/cucm/TransPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/TransPattern/5ae8a472affa931cce3a6051/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a472affa931cce3a6051"
}
]
}
(Show the first instance)
{
"data": {
"callingPartyPrefixDigits": null,
"blockEnable": true,
"patternUrgency": true,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1-noFONet-PT",
"releaseClause": "Call Rejected",
"calledPartyNumberingPlan": "Cisco CallManager",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": false,
"calledPartyTransformationMask": null,
"pattern": "**004!",
"patternPrecedence": "Default",
"callingSearchSpaceName": "Cu1-ANumAnaly-CSS",
"prefixDigitsOut": null,
"useOriginatorCss": false,
"dontWaitForIDTOnSubsequentHops": true,
"connectedNamePresentationBit": "Default",
"description": "Stop 2nd Stg EmerNum being Dailled",
"routeClass": "Default",
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"routeNextHopByCgpn": false,
"usage": "Translation",
"resourcePriorityNamespaceName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"callInterceptProfileName": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"callingLinePresentationBit": "Default"
},
"meta": {
"model_type": "device/cucm/TransPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"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,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/",
"pkid": "5ae8a280affa931cce399277"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a280affa931cce399277"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a280affa931cce399277/?hierarchy=[hierarchy]&model_type=device/cucm/TransPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/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/device/cucm/TransPattern/5ae8a280affa931cce399277/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/TransPattern/5ae8a280affa931cce399277/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a280affa931cce399277"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/TransPattern. | GET | /api/device/cucm/TransPattern/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/TransPattern as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/TransPattern/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/TransPattern/[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/TransPattern/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/TransPattern/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/TransPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/TransPattern | 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/TransPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/TransPattern/[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/TransPattern and the JSON format can be used to import instances of device/cucm/TransPattern.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/TransPattern/[pkid] | hierarchy=[hierarchy] | The device/cucm/TransPattern instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/TransPattern/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/TransPattern. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/TransPattern/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |