API Reference for device/skypeforbusiness/CsAddressBookNormalizationRule

Model ref.: device/skypeforbusiness/CsAddressBookNormalizationRule

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "Priority": {
               "__type_requested": "Int32", 
               "required": false, 
               "description": "The order in which rules are applied; this is required because a given phone number might match more than one rule. The Priority parameter sets the order in which the rules are tested against the number. If a phone number matches multiple rules, the rule with the highest priority will be selected to do the conversion.\nNote that, when you set a priority, any existing rules will renumber themselves accordingly.", 
               "title": "Priority", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "Priority"
          }, 
          "Name": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The name to be given to the new rule. This parameter is required if a value has been specified for the Parent parameter. If no value has been specified for the Parent parameter, the Name defaults to the name used in the Identity parameter. For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. The Name parameter and the Identity parameter cannot be used in the same command.", 
               "title": "Name", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Name"
          }, 
          "Parent": {
               "__type_requested": "String", 
               "required": true, 
               "description": "The scope at which the new normalization rule will be created. Address book normalization rules can be created at the global scope, the site scope, or the service scope (for the Address Book service only). Note that a collection of Address Book normalization configuration settings must already be assigned to the specified scope before you can add a rule to that scope. For example, you cannot add a rule to the Redmond site unless you have already creation Address Book normalization configuration settings for that site.\nThe Parent parameter is required unless the Identity parameter is specified. You cannot include the Identity parameter and the Parent parameter in the same command. If you include the Parent parameter, the Name parameter is also required.", 
               "title": "Parent", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Parent"
          }, 
          "Pattern": {
               "__type_requested": "String", 
               "required": false, 
               "description": "A regular expression that the phone number must match in order for this rule to be applied.\nThe default value is ^(\\d{11})$. This expression represents any set of numbers up to 11 digits.", 
               "title": "Pattern", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Pattern"
          }, 
          "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"
          }, 
          "Translation": {
               "__type_requested": "String", 
               "required": false, 
               "description": "The regular expression pattern that will be applied to the number to convert it to E.164 format.\nThe default value is +$. This prefixes the number with a plus sign (+).", 
               "title": "Translation", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Translation"
          }, 
          "Identity": {
               "__type_requested": "System.String", 
               "required": true, 
               "description": "Unique identifier for the rule. The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name.\nNote that the Identity is composed of the Parent (scope) and the Name. If you use the Identity parameter then you cannot use the Name or the Parent parameters.", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "Description": {
               "__type_requested": "String", 
               "required": false, 
               "description": "Enables administrators to provide explanatory text that accompanies a normalization rule. For example, the Description might explain how the rule converts phone numbers.", 
               "title": "Description", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Description"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusiness/CsAddressBookNormalizationRule 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/device/skypeforbusiness/CsAddressBookNormalizationRule/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusiness/CsAddressBookNormalizationRule/[pkid1]", "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/skypeforbusiness/CsAddressBookNormalizationRule
```
GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookNormalizationRule/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/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/CsAddressBookNormalizationRule device/skypeforbusiness/CsAddressBookNormalizationRule schema to create POST payload.

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

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

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

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

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

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

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

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "Name", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/?skip=0&limit=3&order_by=Name&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": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/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/CsAddressBookNormalizationRule", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/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/CsAddressBookNormalizationRule/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusiness/CsAddressBookNormalizationRule/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusiness/CsAddressBookNormalizationRule", 
          "model_specific_actions": [
               "get", 
               "list", 
               "add", 
               "remove", 
               "update", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "Name", 
                    "title": "Name"
               }, 
               {
                    "name": "Description", 
                    "title": "Description"
               }, 
               {
                    "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/CsAddressBookNormalizationRule.	GET	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusiness/CsAddressBookNormalizationRule 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/CsAddressBookNormalizationRule/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/[pkid]/	hierarchy=[hierarchy]

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

GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookNormalizationRule/?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/CsAddressBookNormalizationRule	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/CsAddressBookNormalizationRule; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusiness/CsAddressBookNormalizationRule/[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

For Bulk Export, refer to the Bulk Export section.

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

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

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

API Reference for device/skypeforbusiness/CsAddressBookNormalizationRule

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

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

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

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge