[Index]
Model ref.: device/cucm/CallingPartyTransformationPattern
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": {
"mlppPreemptionDisabled": {
"description": "Check this check box to make the numbers in a transformation pattern nonpreemptable. \n \n \n \n Note\u00a0\u00a0\u00a0 \n For MLPP Preemption Disabled check box to work, create the transformation patterns and put them into partitions, import all such partitions into a CSS (for example, NonPreemptionCSS), and select the CSS in \"Non-Preemption Pattern CSS\" service parameter (System > Service Parameters). \n \n \n ",
"title": "Mlpp Preemption Disabled",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callingPartyNumberType": {
"description": " Choose the format for the number type in calling party directory numbers. \n Cisco Unified Communications Manager sets the calling directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the calling directory number to be encoded to a non national type numbering plan. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014Use when the \n Cisco Unified Communications Manager sets the directory number type. \n \n Unknown\u2014Use when the dialing plan is unknown. \n \n National\u2014Use when you are dialing within the dialing plan for your country. \n \n International\u2014Use when you are dialing outside the dialing plan for your country. \n \n Subscriber\u2014Use when you are dialing a subscriber by using a shortened subscriber number. \n ",
"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"
},
"description": {
"description": " Enter a description of the transformation pattern. ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callingPartyPrefixDigits": {
"description": " Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9, the wildcard characters asterisk (*) and octothorpe (#), and the international escape character +. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The appended prefix digit does not affect which directory numbers route to the assigned device. \n \n \n ",
"title": "Calling Party Prefix Digits",
"minItems": 0,
"pattern": "^[0-9*#+]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"pattern": {
"description": " Enter the transformation pattern, including numbers and wildcards (do not use spaces); for example, for NANP, enter 9.@ for typical local access or 8XXX for a typical private network numbering plan. Valid characters include the uppercase characters A, B, C, and D and \\+, which represents the international escape character +. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the pattern is unique. Check the transformation pattern, route pattern, translation pattern, directory number, call park number, call pickup number, message waiting on/off, or meet me number if you receive an error that indicates duplicate entries. You can also check the route plan report. \n \n \n ",
"title": "Pattern",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"dialPlanName": {
"description": " Choose a numbering plan. ",
"title": "Dial Plan Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/DialPlan",
"choices": []
},
"routeFilterName": {
"description": " If your transformation pattern includes the @ wildcard, you may choose a route filter. The optional act of choosing a route filter restricts certain number patterns. The route filters that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. You can configure the number of items that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more route filters exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Route Filters window, then find and choose a route filter name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. \n \n \n ",
"title": "Route Filter Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RouteFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/RouteFilter",
"choices": []
},
"callingPartyNumberingPlan": {
"description": " Choose the format for the numbering plan in calling party directory numbers. \n Cisco Unified Communications Manager sets the calling DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because \n Cisco Unified Communications Manager does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non-national type number. Choose one of the following options: \n \n \n \n \n Cisco Unified Communications Manager\u2014Use when the \n Cisco Unified Communications Manager sets the Numbering Plan in the directory number. \n \n ISDN\u2014Use when you are dialing outside the dialing plan for your country. \n \n National Standard\u2014Use when you are dialing within the dialing plan for your country. \n \n Private\u2014Use when you are dialing within a private network. \n \n Unknown\u2014Use when the dialing plan is unknown. \n ",
"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"
},
"callingLinePresentationBit": {
"description": " \n Cisco Unified Communications Manager uses calling line ID presentation (CLIP/CLIR) as a supplementary service to allow or restrict the originating caller phone number on a call-by-call basis. Choose whether you want the \n Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this route pattern. Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want \n Cisco Unified Communications Manager to allow the display of the calling number. Choose Restricted if you want \n Cisco Unified Communications Manager to block the display of the calling number. ",
"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"
},
"digitDiscardInstructionName": {
"title": "Digit Discard Instruction Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DiscardDigitInstruction/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DiscardDigitInstruction",
"choices": []
},
"useCallingPartyPhoneMask": {
"description": " Check the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. You may also configure an External Phone Number Mask on all phone devices. ",
"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"
},
"routePartitionName": {
"description": " If you want to use a partition to restrict access to the transformation pattern, choose the desired partition from the drop-down list box. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Configure transformation patterns in different non-null partitions rather than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, \n Cisco Unified Communications Manager ignores the patterns in null partitions. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose CCMAdmin Parameters. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Make sure that the combination of pattern, route filter, and partition is unique within the \n Cisco Unified Communications Manager cluster. \n \n \n ",
"title": "Route Partition Name",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"callingPartyTransformationMask": {
"description": " Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); and the international escape character +. If the Discard Digit Instructions field is blank, the Prefix Digits (Outgoing Calls) field is blank, the Calling Party Transformation Mask field is blank, and the Use Calling Party's External Phone Number Mask is not checked, no calling party transformation takes place. ",
"title": "Calling Party Transformation Mask",
"minItems": 0,
"pattern": "^[0-9*#+X]{0,50}$",
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cucm/CallingPartyTransformationPattern/add/ |
|
The GUI Add form of device/cucm/CallingPartyTransformationPattern 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/CallingPartyTransformationPattern | 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/CallingPartyTransformationPattern/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cucm/CallingPartyTransformationPattern/[pkid1]", "/api/device/cucm/CallingPartyTransformationPattern/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cucm/CallingPartyTransformationPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/CallingPartyTransformationPattern/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/CallingPartyTransformationPattern/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/CallingPartyTransformationPattern/[pkid1]", "/api/v0/device/cucm/CallingPartyTransformationPattern/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/CallingPartyTransformationPattern/?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/CallingPartyTransformationPattern |
|
{"hrefs": ["/api/device/cucm/CallingPartyTransformationPattern/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/CallingPartyTransformationPattern |
|
{"hrefs": ["/api/device/cucm/CallingPartyTransformationPattern/[pkid1]", "/api/device/cucm/CallingPartyTransformationPattern/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/CallingPartyTransformationPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/CallingPartyTransformationPattern/export/ |
|
{ "hrefs":["/api/device/cucm/CallingPartyTransformationPattern/[pkid1]", "/api/device/cucm/CallingPartyTransformationPattern/[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/CallingPartyTransformationPattern and the JSON format can be used to import instances of device/cucm/CallingPartyTransformationPattern.
GET http://[host-proxy]/api/device/cucm/CallingPartyTransformationPattern/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/CallingPartyTransformationPattern | POST | /api/device/cucm/CallingPartyTransformationPattern/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/CallingPartyTransformationPattern/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/CallingPartyTransformationPattern/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/CallingPartyTransformationPattern/ |
|
The device/cucm/CallingPartyTransformationPattern schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/CallingPartyTransformationPattern instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 24,
"total_limit": null,
"order_by": "pattern",
"direction": "asc",
"current": "/api/device/cucm/CallingPartyTransformationPattern/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=down"
},
"operations": [
"update",
"field_display_policy",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update_form",
"transform",
"clone",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "device/cucm/CallingPartyTransformationPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "dialPlanName",
"title": "Dial Plan Name"
},
{
"name": "routeFilterName",
"title": "Route Filter Name"
},
{
"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": [
"update",
"field_display_policy",
"remove",
"help",
"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/CallingPartyTransformationPattern/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/CallingPartyTransformationPattern/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cucm/CallingPartyTransformationPattern/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/CallingPartyTransformationPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cucm/CallingPartyTransformationPattern/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/CallingPartyTransformationPattern/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cucm/CallingPartyTransformationPattern/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cucm/CallingPartyTransformationPattern/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cucm/CallingPartyTransformationPattern/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/CallingPartyTransformationPattern/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/CallingPartyTransformationPattern/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"mlppPreemptionDisabled": false,
"callingPartyNumberType": "Cisco CallManager",
"description": "Wild card match all patterns",
"callingPartyPrefixDigits": null,
"pattern": "!",
"dialPlanName": null,
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"callingLinePresentationBit": "Default",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "On",
"routePartitionName": "Cu1-DN2DDI4RCCN-PT",
"callingPartyTransformationMask": null,
"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/CallingPartyTransformationPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "dialPlanName",
"title": "Dial Plan Name"
},
{
"name": "routeFilterName",
"title": "Route Filter Name"
},
{
"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": {
"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/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/",
"pkid": "5ae8a232affa931cce397a0d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a232affa931cce397a0d"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a232affa931cce397a0d/?model_type=device/cucm/CallingPartyTransformationPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a232affa931cce397a0d"
},
{
"data": {
"mlppPreemptionDisabled": false,
"callingPartyNumberType": "Cisco CallManager",
"description": "Wild card match all patterns",
"callingPartyPrefixDigits": null,
"pattern": "!",
"dialPlanName": null,
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"callingLinePresentationBit": "Default",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "On",
"routePartitionName": "Cu1-DN2DDI4RCCN-PT",
"callingPartyTransformationMask": null,
"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/CallingPartyTransformationPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "dialPlanName",
"title": "Dial Plan Name"
},
{
"name": "routeFilterName",
"title": "Route Filter Name"
},
{
"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": {
"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/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/",
"pkid": "5ae8a426affa931cce3a4d79"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a426affa931cce3a4d79"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a426affa931cce3a4d79/?model_type=device/cucm/CallingPartyTransformationPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a426affa931cce3a4d79/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a426affa931cce3a4d79"
},
{
"data": {
"mlppPreemptionDisabled": false,
"callingPartyNumberType": "Cisco CallManager",
"description": "DN wo DDI or from other site",
"callingPartyPrefixDigits": null,
"pattern": "*10*!",
"dialPlanName": null,
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"callingLinePresentationBit": "Default",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "Off",
"routePartitionName": "Cu1-DN2DDI4Emer-PT",
"callingPartyTransformationMask": "+441179693832",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "CL2-AB-C-Fleet (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL2-AB-C-Fleet"
},
"meta": {
"model_type": "device/cucm/CallingPartyTransformationPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "dialPlanName",
"title": "Dial Plan Name"
},
{
"name": "routeFilterName",
"title": "Route Filter Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "*10*!",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae8a0aaaffa931cce391f59",
"href": "/api/data/HierarchyNode/5ae8a0aaaffa931cce391f59"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/",
"pkid": "5ae8a6b3affa931cce3abdb1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae8a0aaaffa931cce391f59",
"5ae8a6b3affa931cce3abdb1"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a6b3affa931cce3abdb1/?model_type=device/cucm/CallingPartyTransformationPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a6b3affa931cce3abdb1/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a6b3affa931cce3abdb1"
}
]
}
(Show the first instance)
{
"data": {
"mlppPreemptionDisabled": false,
"callingPartyNumberType": "Cisco CallManager",
"callingPartyPrefixDigits": null,
"pattern": "!",
"dialPlanName": null,
"routeFilterName": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"callingLinePresentationBit": "Default",
"digitDiscardInstructionName": null,
"routePartitionName": "Cu1-DN2DDI4RCCN-PT",
"useCallingPartyPhoneMask": "On",
"callingPartyTransformationMask": null,
"description": "Wild card match all patterns"
},
"meta": {
"model_type": "device/cucm/CallingPartyTransformationPattern",
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Route Partition Name"
},
{
"name": "dialPlanName",
"title": "Dial Plan Name"
},
{
"name": "routeFilterName",
"title": "Route Filter Name"
},
{
"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/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/",
"pkid": "5ae8a232affa931cce397a0d"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a232affa931cce397a0d"
],
"schema_version": "10.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a232affa931cce397a0d/?hierarchy=[hierarchy]&model_type=device/cucm/CallingPartyTransformationPattern",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/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/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/CallingPartyTransformationPattern/5ae8a232affa931cce397a0d/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a232affa931cce397a0d"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/CallingPartyTransformationPattern. | GET | /api/device/cucm/CallingPartyTransformationPattern/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/CallingPartyTransformationPattern as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/CallingPartyTransformationPattern/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/CallingPartyTransformationPattern/[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/CallingPartyTransformationPattern/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/CallingPartyTransformationPattern/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/CallingPartyTransformationPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/CallingPartyTransformationPattern | 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/CallingPartyTransformationPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/CallingPartyTransformationPattern/[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/CallingPartyTransformationPattern and the JSON format can be used to import instances of device/cucm/CallingPartyTransformationPattern.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/CallingPartyTransformationPattern/[pkid] | hierarchy=[hierarchy] | The device/cucm/CallingPartyTransformationPattern instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/CallingPartyTransformationPattern/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/CallingPartyTransformationPattern. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/CallingPartyTransformationPattern/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |