API Reference for device/cucm/CalledPartyTransformationPattern

Model ref.: device/cucm/CalledPartyTransformationPattern

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "mlppPreemptionDisabled": {
               "title": "Mlpp Preemption Disabled",
               "minItems": 0,
               "required": false,
               "default": false,
               "maxItems": 1,
               "type": "boolean"
          },
          "calledPartyNumberType": {
               "description": "Choose the format for the number type in called party directory numbers. \n    Cisco Unified Communications Manager sets the called party 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 called directory number to be encoded to a non national type numbering plan. Choose one of the following options: \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": "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"
          },
          "description": {
               "description": "Enter a description of the transformation pattern. The description can include up to 50 characters in any language, but it cannot include double-quotes (\"), percentage sign (%), ampersand (&), or angle brackets (<>). ",
               "title": "Description",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": "string"
          },
          "calledPartyTransformationMask": {
               "description": "Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is not checked, no transformation takes place. ",
               "title": "Called Party Transformation Mask",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "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 letters 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": "Numbering Plan",
               "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",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": [
                    "string",
                    "null"
               ]
          },
          "digitDiscardInstructionName": {
               "title": "Digit Discard Instruction Name",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": [
                    "string",
                    "null"
               ]
          },
          "calledPartyPrefixDigits": {
               "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 (#), the international escape character +, and blank. \n \n  \n   \n    Note\u00a0\u00a0\u00a0 \n    The appended prefix digit does not affect which directory numbers get routed to the assigned device. \n   \n  \n  ",
               "title": "Prefix Digits",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": [
                    "string",
                    "null"
               ]
          },
          "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. If you do not want to restrict access to the transformation pattern, choose <None> for the partition.  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    Transformation patterns should be configured in different non- NULL partitions than dialing patterns such as route patterns and directory numbers. For transformation pattern lookups, the patterns in NULL partitions get ignored. \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": "Partition",
               "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": []
          },
          "calledPartyNumberingPlan": {
               "description": "Choose the format for the numbering plan in called party directory numbers. \n    Cisco Unified Communications Manager sets the called 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     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": "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"
          }
     },
     "schema_version": "14.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/cucm/CalledPartyTransformationPattern/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/cucm/CalledPartyTransformationPattern 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/CalledPartyTransformationPattern	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/CalledPartyTransformationPattern/	hierarchy=[hierarchy]	{"hrefs":["/api/device/cucm/CalledPartyTransformationPattern/[pkid1]", "/api/device/cucm/CalledPartyTransformationPattern/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/cucm/CalledPartyTransformationPattern
```
GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cucm/CalledPartyTransformationPattern/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cucm/CalledPartyTransformationPattern device/cucm/CalledPartyTransformationPattern schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cucm/CalledPartyTransformationPattern/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/CalledPartyTransformationPattern/[pkid1]", "/api/v0/device/cucm/CalledPartyTransformationPattern/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cucm/CalledPartyTransformationPattern	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cucm/CalledPartyTransformationPattern/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cucm/CalledPartyTransformationPattern	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cucm/CalledPartyTransformationPattern/[pkid1]", "/api/device/cucm/CalledPartyTransformationPattern/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/CalledPartyTransformationPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cucm/CalledPartyTransformationPattern/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cucm/CalledPartyTransformationPattern/[pkid1]", "/api/device/cucm/CalledPartyTransformationPattern/[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/CalledPartyTransformationPattern and the JSON format can be used to import instances of device/cucm/CalledPartyTransformationPattern.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/cucm/CalledPartyTransformationPattern:

 GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cucm/CalledPartyTransformationPattern	POST	/api/device/cucm/CalledPartyTransformationPattern/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cucm/CalledPartyTransformationPattern	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cucm/CalledPartyTransformationPattern/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cucm/CalledPartyTransformationPattern/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/cucm/CalledPartyTransformationPattern/	hierarchy=[hierarchy] format=json schema=true	The device/cucm/CalledPartyTransformationPattern schema and all instances as JSON.

(The list will return 0 to 3 device/cucm/CalledPartyTransformationPattern instances)

GET http://[host]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "pattern",
          "direction": "asc",
          "current": "/api/device/cucm/CalledPartyTransformationPattern/?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/CalledPartyTransformationPattern",
          "summary_attrs": [
               {
                    "name": "pattern",
                    "title": "Pattern"
               },
               {
                    "name": "description",
                    "title": "Description"
               },
               {
                    "name": "routePartitionName",
                    "title": "Partition"
               },
               {
                    "name": "dialPlanName",
                    "title": "Numbering Plan"
               },
               {
                    "name": "routeFilterName",
                    "title": "Route Filter"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "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/CalledPartyTransformationPattern/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "bulk_update_form": {
                         "method": "GET",
                         "class": "update",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/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/CalledPartyTransformationPattern",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/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/CalledPartyTransformationPattern/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               },
               {
                    "purge": {
                         "method": "POST",
                         "class": "purge",
                         "href": "/api/device/cucm/CalledPartyTransformationPattern/purge/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Purge"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cucm/CalledPartyTransformationPattern.	GET	/api/device/cucm/CalledPartyTransformationPattern/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cucm/CalledPartyTransformationPattern as HTML

Task	Call	URL	Parameters	Response
Purge	POST	/api/device/cucm/CalledPartyTransformationPattern/purge/	hierarchy=[hierarchy] format=json

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/cucm/CalledPartyTransformationPattern/[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/CalledPartyTransformationPattern/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cucm/CalledPartyTransformationPattern/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cucm/CalledPartyTransformationPattern

GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cucm/CalledPartyTransformationPattern	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/CalledPartyTransformationPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cucm/CalledPartyTransformationPattern/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/CalledPartyTransformationPattern and the JSON format can be used to import instances of device/cucm/CalledPartyTransformationPattern.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cucm/CalledPartyTransformationPattern/[pkid]	hierarchy=[hierarchy]	The device/cucm/CalledPartyTransformationPattern instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/cucm/CalledPartyTransformationPattern/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/cucm/CalledPartyTransformationPattern.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cucm/CalledPartyTransformationPattern/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/cucm/CalledPartyTransformationPattern

GET http://[host-proxy]/api/device/cucm/CalledPartyTransformationPattern/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cucm/CalledPartyTransformationPattern/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Purge

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge