API Reference for device/skypeforbusiness/CsDialPlan

Model ref.: device/skypeforbusiness/CsDialPlan

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/skypeforbusiness/CsDialPlan/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "City": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not used with this cmdlet.", 
               "title": "City", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "City"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A description of this dial plan--what it's for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan.\nMaximum characters: 512", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }, 
          "CountryCode": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not used with this cmdlet.", 
               "title": "CountryCode", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "CountryCode"
          }, 
          "ExternalAccessPrefix": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number.\nThe OptimizeDeviceDialing parameter must be set to True for this value to take effect.\nThis parameter must match the regular expression [0-9]{1,4}. This means it must be a value 0 through 9, one to four digits in length.\nDefault: 9", 
               "title": "ExternalAccessPrefix", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "ExternalAccessPrefix"
          }, 
          "DialinConferencingRegion": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. Available regions can be retrieved by calling the Get-CsNetworkRegion cmdlet.\nMaximum characters: 512", 
               "title": "DialinConferencingRegion", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "DialinConferencingRegion"
          }, 
          "State": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not used with this cmdlet.", 
               "title": "State", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "State"
          }, 
          "ScopeClass": {
               "__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass", 
               "required": false, 
               "name": "ScopeClass", 
               "title": "ScopeClass", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Element": {
               "__type_requested": "System.Xml.Linq.XElement", 
               "required": false, 
               "name": "Element", 
               "title": "Element", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "InMemory": {
               "__type_requested": "SwitchParameter", 
               "required": false, 
               "description": "Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-<cmdlet>.", 
               "title": "InMemory", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "InMemory"
          }, 
          "SimpleName": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A display name for the dial plan. This name must be unique among all dial plans within the Skype for Business Server 2015 deployment.\nThis string can be up to 256 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_), and parentheses (()).\nThis parameter must contain a value. However, if you don't provide a value in the call to the New-CsDialPlan cmdlet, a default value will be supplied. The default value for a Global dial plan is Prefix All. The default for a site-level dial plan is the name of the site. The default for a service is the name of the service (Registrar or PSTN gateway) followed by an underscore, followed by the service fully qualified domain name (FQDN). For example, Registrar_pool0.litwareinc.com. The default for a per-user dial plan is the Identity of the dial plan.", 
               "title": "SimpleName", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "SimpleName"
          }, 
          "OptimizeDeviceDialing": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter.\nDefault: False", 
               "title": "OptimizeDeviceDialing", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "OptimizeDeviceDialing"
          }, 
          "NormalizationRules": {
               "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule]", 
               "required": false, 
               "description": "A list of normalization rules that are applied to this dial plan.\nWhile this list and these rules can be created directly with this cmdlet, we recommend that you create the normalization rules with the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified dial plan.\nEach time a new dial plan is created, a new voice normalization rule with default settings is also created for that site, service, or per-user dial plan. By default the Identity of the new voice normalization rule is the dial plan Identity followed by a slash followed by the name Prefix All. For example, site:Redmond/Prefix All.\nDefault: {Description=;Pattern=^(\\d11)$;Translation=+$1;Name=Prefix All;IsInternalExtension=False } Note: This default is only a placeholder. For the dial plan to be useful, you should either modify the normalization rule created by the dial plan or create a new rule for the site, service, or user. You can create a new normalization rule by calling the New-CsVoiceNormalizationRule cmdlet; modify a normalization rule by calling the Set-CsVoiceNormalizationRule cmdlet.", 
               "title": "NormalizationRules", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "NormalizationRules"
          }, 
          "Anchor": {
               "__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor", 
               "required": false, 
               "name": "Anchor", 
               "title": "Anchor", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "type": "string", 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "A unique identifier designating the scope and name (site), the service role and FQDN, or the name (per user) to identify the dial plan. For example, a site Identity would be entered in the format site:<sitename>, where sitename is the name of the site. A dial plan at the service scope must be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. A per-user Identity would be entered simply as a unique string value.", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }
     }, 
     "schema_version": "1150"
}

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

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusiness/CsDialPlan/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsDialPlan/[pkid1]", "/api/v0/device/skypeforbusiness/CsDialPlan/[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/skypeforbusiness/CsDialPlan/?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/skypeforbusiness/CsDialPlan	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsDialPlan/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusiness/CsDialPlan	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusiness/CsDialPlan/[pkid1]", "/api/device/skypeforbusiness/CsDialPlan/[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/skypeforbusiness/CsDialPlan/?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/skypeforbusiness/CsDialPlan; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusiness/CsDialPlan/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusiness/CsDialPlan/[pkid1]", "/api/device/skypeforbusiness/CsDialPlan/[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/skypeforbusiness/CsDialPlan and the JSON format can be used to import instances of device/skypeforbusiness/CsDialPlan.

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

 GET http://[host-proxy]/api/device/skypeforbusiness/CsDialPlan/?hierarchy=[hierarchy]

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusiness/CsDialPlan/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/skypeforbusiness/CsDialPlan/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/skypeforbusiness/CsDialPlan/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusiness/CsDialPlan schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusiness/CsDialPlan instances)

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

{
     "operations": [
          "cs_dial_plan", 
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Identity", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusiness/CsDialPlan/?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": {}, 
          "schema_version": "1150", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/skypeforbusiness/CsDialPlan", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "cs_dial_plan": {
                         "support_async": true, 
                         "class": "custom", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/+cs_dial_plan/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Cs Dial Plan"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusiness/CsDialPlan/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusiness/CsDialPlan", 
          "model_specific_actions": [
               "list", 
               "get", 
               "cs_dial_plan", 
               "powershell_disable", 
               "powershell_enable", 
               "powershell_move", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Identity", 
                    "title": "Identity"
               }, 
               {
                    "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 device/skypeforbusiness/CsDialPlan.	GET	/api/device/skypeforbusiness/CsDialPlan/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusiness/CsDialPlan as HTML

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/skypeforbusiness/CsDialPlan/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusiness/CsDialPlan/[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/skypeforbusiness/CsDialPlan

GET http://[host-proxy]/api/device/skypeforbusiness/CsDialPlan/?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/skypeforbusiness/CsDialPlan	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/skypeforbusiness/CsDialPlan; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusiness/CsDialPlan/[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/skypeforbusiness/CsDialPlan and the JSON format can be used to import instances of device/skypeforbusiness/CsDialPlan.

For Bulk Export, refer to the Bulk Export section.

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

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

Task	Call	URL	Parameters	Payload
Powershell Disable	POST	/api/device/skypeforbusiness/CsDialPlan/[pkid]/+powershell_disable/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Powershell Enable	POST	/api/device/skypeforbusiness/CsDialPlan/[pkid]/+powershell_enable/	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Payload
Powershell Move	POST	/api/device/skypeforbusiness/CsDialPlan/[pkid]/+powershell_move/	hierarchy=[hierarchy]	If payload required:

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

API Reference for device/skypeforbusiness/CsDialPlan

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

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Powershell Disable

Powershell Enable

Powershell Move

Purge