[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": { "title": "Dial Plan Name", "type": "string", "required": true }, "Identity": { "title": "Name", "description": "The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify.", "type": "string", "required": true }, "Description": { "title": "Description", "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.", "type": "string" }, "SimpleName": { "title": "Simple Name", "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 (()).", "type": "string" }, "NormalizationRules": { "title": "Normalization Rules", "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.", "type": "array", "items": { "type": "object", "properties": { "Description": { "title": "Description", "description": "A friendly description of the normalization rule. Maximum string length: 512 characters.", "type": "string" }, "Name": { "title": "Name", "description": "The name of the normalization rule", "type": "string" }, "Pattern": { "title": "Pattern", "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.)", "type": "string" }, "Translation": { "title": "Translation", "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 [+].)", "type": "string" }, "IsInternalExtension": { "title": "Is Internal Extension", "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. Default: False", "type": "boolean" } } } } }, "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 |
---|---|---|---|---|
Tag | PATCH | /api/data/DP_msteamsonline_CsTenantDialplan/+tag/ |
|
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)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 0, "total_limit": null, "order_by": "Identity", "direction": "asc", "current": "/api/data/DP_msteamsonline_CsTenantDialplan/?skip=0&limit=3&order_by=Identity&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/DP_msteamsonline_CsTenantDialplan", "summary_attrs": [ { "name": "Identity", "title": "Name" }, { "name": "SimpleName", "title": "Simple Name" }, { "name": "Description", "title": "Description" }, { "name": "dpName", "title": "Dial Plan Name" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "? - ? - ? - ?", "business_key": { "unique": [ "Identity", "SimpleName", "Description", "dpName" ], "hierarchy": true }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "schema_version": "0.1", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/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/data/DP_msteamsonline_CsTenantDialplan/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/DP_msteamsonline_CsTenantDialplan/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "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. |