[Index]
This relation wraps the device/cucm/CalledPartyTransformationPattern element.
Model ref.: relation/HcsCdPtyXformREL
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": {
"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. ",
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/DialPlan",
"title": "Numbering Plan",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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": {
"minItems": 0,
"required": false,
"type": [
"string",
"null"
],
"maxItems": 1,
"title": "Digit Discard Instruction Name"
},
"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"
]
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"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 ",
"format": "uri",
"minItems": 1,
"required": true,
"choices": [],
"target_attr": "name",
"maxItems": 1,
"target_model_type": "device/cucm/RoutePartition",
"title": "Partition",
"type": [
"string",
"null"
],
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"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": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsCdPtyXformREL/add/ |
|
The GUI Add form of relation/HcsCdPtyXformREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/HcsCdPtyXformREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsCdPtyXformREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsCdPtyXformREL/[pkid1]", "/api/relation/HcsCdPtyXformREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsCdPtyXformREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsCdPtyXformREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsCdPtyXformREL/export/ |
|
{ "hrefs":["/api/relation/HcsCdPtyXformREL/[pkid1]", "/api/relation/HcsCdPtyXformREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsCdPtyXformREL and the JSON format can be used to import instances of relation/HcsCdPtyXformREL.
GET http://[host-proxy]/api/relation/HcsCdPtyXformREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsCdPtyXformREL | POST | /api/relation/HcsCdPtyXformREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsCdPtyXformREL/ |
|
The relation/HcsCdPtyXformREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsCdPtyXformREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "pattern",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsCdPtyXformREL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsCdPtyXformREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsCdPtyXformREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsCdPtyXformREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsCdPtyXformREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsCdPtyXformREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsCdPtyXformREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsCdPtyXformREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsCdPtyXformREL",
"model_specific_actions": [
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "pattern",
"title": "Pattern"
},
{
"name": "description",
"title": "Description"
},
{
"name": "routePartitionName",
"title": "Partition"
},
{
"name": "dialPlanName",
"title": "Numbering Plan"
},
{
"name": "routeFilterName",
"title": "Route Filter"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsCdPtyXformREL. | GET | /api/relation/HcsCdPtyXformREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsCdPtyXformREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsCdPtyXformREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsCdPtyXformREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsCdPtyXformREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsCdPtyXformREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsCdPtyXformREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsCdPtyXformREL/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsCdPtyXformREL and the JSON format can be used to import instances of relation/HcsCdPtyXformREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsCdPtyXformREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsCdPtyXformREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsCdPtyXformREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsCdPtyXformREL. |