[Index]
Dial PlanTranslation Patterns
Model ref.: data/DP_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": {
"provideOutsideDialTone": {
"type": "boolean",
"title": "Provide Outside Dial Tone"
},
"callingPartyPrefixDigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"callingPartyTransformMask": {
"type": "string",
"title": "Calling Party Transform Mask"
},
"nextHopByCallingPtyNum": {
"type": "boolean",
"title": "Route Next Hop By Calling Party Number"
},
"releaseClause": {
"default": "No Error",
"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"
}
],
"type": "string",
"description": "If this is a blocking pattern, select the release clause when the call is blocked.",
"title": "Release Clause"
},
"calledPartyDiscardDigits": {
"title": "Called Party Discard Digits",
"type": "string",
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"pattern": {
"type": "string",
"description": "Translation Pattern",
"title": "Translation Pattern"
},
"routeOption": {
"default": "Route this pattern",
"title": "Route Option",
"type": "string",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"noWaitInterdigitTimeoutSubseqHops": {
"type": "boolean",
"title": "Do Not Wait For Interdigit Timeout On Subsequent Hops"
},
"css": {
"type": "string",
"title": "Css"
},
"dpLocal": {
"default": "{{ fn.false }}",
"type": "boolean",
"description": "Translation pattern designation as local dialing built from Dial Plan Input Data",
"title": "Local Dialing"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Translation Pattern Description",
"title": "Translation Pattern Description"
},
"calledPartyPrefixDigits": {
"type": "string",
"title": "Called Party Prefix Digits (Outgoing Calls)"
},
"calledPartyTransformMask": {
"type": "string",
"title": "Called Party Transform Mask"
},
"cgLinePresBit": {
"default": "Default",
"title": "Calling Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"default": "Default",
"title": "Connected Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"partition": {
"type": "string",
"description": "Partition",
"title": "Partition"
},
"useCallingPartyExternalPhoneNumMask": {
"type": "boolean",
"title": "Use Calling Party's External Phone Number Mask"
},
"cgNamePresBit": {
"default": "Default",
"title": "Calling Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"default": "Default",
"title": "Connected Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"useOrigCss": {
"type": "boolean",
"title": "Use Originator's Calling Search Space"
},
"urgentPriority": {
"type": "boolean",
"title": "Urgent Priority"
}
},
"schema_version": "0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DP_TransPattern/add/ |
|
The GUI Add form of data/DP_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/data/DP_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/data/DP_TransPattern/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_TransPattern/[pkid1]", "/api/data/DP_TransPattern/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_TransPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_TransPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_TransPattern/export/ |
|
{ "hrefs":["/api/data/DP_TransPattern/[pkid1]", "/api/data/DP_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 data/DP_TransPattern and the JSON format can be used to import instances of data/DP_TransPattern.
GET http://[host-proxy]/api/data/DP_TransPattern/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DP_TransPattern | POST | /api/data/DP_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/data/DP_TransPattern/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/DP_TransPattern/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DP_TransPattern/ |
|
The data/DP_TransPattern schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_TransPattern instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"move",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "dpName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/DP_TransPattern/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "? - ? - ?",
"business_key": {
"hierarchy": true,
"unique": [
"dpName",
"pattern",
"partition"
]
},
"schema_version": "0.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/DP_TransPattern/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DP_TransPattern/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_TransPattern/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/DP_TransPattern/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_TransPattern/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/DP_TransPattern/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/DP_TransPattern/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/DP_TransPattern/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DP_TransPattern/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DP_TransPattern",
"model_specific_actions": [
"add",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"update"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "dpLocal",
"title": "Local Dialing"
},
{
"name": "pattern",
"title": "Translation Pattern"
},
{
"name": "partition",
"title": "Partition"
},
{
"name": "description",
"title": "Translation Pattern Description"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "19.3.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/DP_TransPattern. | GET | /api/data/DP_TransPattern/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_TransPattern as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DP_TransPattern/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/DP_TransPattern/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_TransPattern/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_TransPattern/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/DP_TransPattern; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_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 data/DP_TransPattern and the JSON format can be used to import instances of data/DP_TransPattern.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DP_TransPattern/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DP_TransPattern/[pkid]/ | hierarchy=[hierarchy] | The data/DP_TransPattern instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DP_TransPattern/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_TransPattern. |