[Index]
Dial plan template model for device/msteamsonline/CsTenantDialplan version 2019.1
Model ref.: data/DP_msteamsonline_CsTenantDialplan
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": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"Description": {
"type": "string",
"description": "The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040.",
"title": "Description"
},
"ExternalAccessPrefix": {
"type": "string",
"description": "The ExternalAccessPrefix parameter is a number (or set of numbers) that designates the call as external to the organization. (For example, to tenant-dial an outside line, first dial 9). This prefix is ignored by the normalization rules, although these rules will be applied to the rest of the number. The OptimizeDeviceDialing parameter must be set to True for this value to take effect. The value of this parameter must be no longer than 4 characters long and can contain only digits, \"#\" or a \"*\".",
"title": "External Access Prefix"
},
"SimpleName": {
"type": "string",
"description": "The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()).",
"title": "Simple Name"
},
"OptimizeDeviceDialing": {
"type": "boolean",
"description": "Use this parameter to determine the effect of ExternalAccessPrefix parameter. If set to True, the ExternalAccessPrefix parameter takes effect.",
"title": "Optimize Device Dialing"
},
"NormalizationRules": {
"items": {
"type": "object",
"properties": {
"Pattern": {
"type": "string",
"description": "A regular expression that the dialed number must match in order for this rule to be applied. Default: ^(\\d{11})$ (The default represents any set of numbers up to 11 digits.)",
"title": "Pattern"
},
"Translation": {
"type": "string",
"description": "The regular expression pattern that will be applied to the number to convert it to E.164 format. Default: +$1 (The default prefixes the number with a plus sign [+].)",
"title": "Translation"
},
"IsInternalExtension": {
"type": "boolean",
"description": "If True, the result of applying this rule will be a number internal to the organization. If False, applying the rule results in an external number. This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan is set to False. Default: False",
"title": "Is Internal Extension"
},
"Description": {
"type": "string",
"description": "A friendly description of the normalization rule. Maximum string length: 512 characters.",
"title": "Description"
},
"Name": {
"type": "string",
"description": "The name of the normalization rule",
"title": "Name"
}
}
},
"type": "array",
"description": "The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. The number of normalization rules cannot exceed 50 per TenantDialPlan.",
"title": "Normalization Rules"
},
"Identity": {
"required": true,
"type": "string",
"description": "The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify.",
"title": "Name"
}
},
"schema_version": "0.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/DP_msteamsonline_CsTenantDialplan/add/ |
|
The GUI Add form of data/DP_msteamsonline_CsTenantDialplan 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_msteamsonline_CsTenantDialplan | 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_msteamsonline_CsTenantDialplan/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_msteamsonline_CsTenantDialplan/[pkid1]", "/api/data/DP_msteamsonline_CsTenantDialplan/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_msteamsonline_CsTenantDialplan; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_msteamsonline_CsTenantDialplan/export/ |
|
{ "hrefs":["/api/data/DP_msteamsonline_CsTenantDialplan/[pkid1]", "/api/data/DP_msteamsonline_CsTenantDialplan/[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_msteamsonline_CsTenantDialplan and the JSON format can be used to import instances of data/DP_msteamsonline_CsTenantDialplan.
GET http://[host-proxy]/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/DP_msteamsonline_CsTenantDialplan | POST | /api/data/DP_msteamsonline_CsTenantDialplan/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_msteamsonline_CsTenantDialplan/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_msteamsonline_CsTenantDialplan/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/DP_msteamsonline_CsTenantDialplan/ |
|
The data/DP_msteamsonline_CsTenantDialplan schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_msteamsonline_CsTenantDialplan 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": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/DP_msteamsonline_CsTenantDialplan/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "? - ? - ? - ?",
"business_key": {
"hierarchy": true,
"unique": [
"Identity",
"SimpleName",
"Description",
"dpName"
]
},
"schema_version": "0.1",
"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_msteamsonline_CsTenantDialplan/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/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_msteamsonline_CsTenantDialplan/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/DP_msteamsonline_CsTenantDialplan/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/DP_msteamsonline_CsTenantDialplan",
"model_specific_actions": [
"add",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"remove",
"tag",
"update"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Name"
},
{
"name": "SimpleName",
"title": "Simple Name"
},
{
"name": "Description",
"title": "Description"
},
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"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 data/DP_msteamsonline_CsTenantDialplan. | GET | /api/data/DP_msteamsonline_CsTenantDialplan/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_msteamsonline_CsTenantDialplan as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/DP_msteamsonline_CsTenantDialplan/[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_msteamsonline_CsTenantDialplan/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_msteamsonline_CsTenantDialplan/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_msteamsonline_CsTenantDialplan/?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_msteamsonline_CsTenantDialplan; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_msteamsonline_CsTenantDialplan/[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_msteamsonline_CsTenantDialplan and the JSON format can be used to import instances of data/DP_msteamsonline_CsTenantDialplan.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/DP_msteamsonline_CsTenantDialplan/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/DP_msteamsonline_CsTenantDialplan/[pkid] | hierarchy=[hierarchy] | The data/DP_msteamsonline_CsTenantDialplan instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/DP_msteamsonline_CsTenantDialplan/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_msteamsonline_CsTenantDialplan. |