[Index]
Model ref.: device/skypeforbusiness/CsAddressBookConfiguration
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": { "PhotoCacheRefreshInterval": { "__type_requested": "timespan", "required": false, "description": "PARAMVALUE: TimeSpan", "title": "PhotoCacheRefreshInterval", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "PhotoCacheRefreshInterval" }, "IgnoreGenericRules": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. Generic rules are the rules that are built into Skype for Business Server 2015. These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. The default value is False.", "title": "IgnoreGenericRules", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IgnoreGenericRules" }, "SynchronizePollingInterval": { "__type_requested": "timespan", "required": false, "description": "Indicates how often Address Book servers synchronize their information with the information stored in the User database. The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). The default value is 5 minutes (00:05:00).", "title": "SynchronizePollingInterval", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "SynchronizePollingInterval" }, "EnablePhotoSearch": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, user photos will be displayed in search results.", "title": "EnablePhotoSearch", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnablePhotoSearch" }, "KeepDuration": { "__type_requested": "UInt32", "required": false, "description": "Specifies the amount of time (in days) that Address Book servers will keep change files. Change files older than the value of the KeepDuration property will be deleted. The KeepDuration can be set to any integer value between 1 and 90, inclusive. The default value is 30 days.", "title": "KeepDuration", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "KeepDuration" }, "UseNormalizationRules": { "__type_requested": "$true | $false", "required": false, "description": "Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. If set to False, phone numbers will be retrieved as-is, and it will be up to the client application to apply normalization rules when displaying these numbers.\nThe default value is True.", "title": "UseNormalizationRules", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "UseNormalizationRules" }, "EnableFileGeneration": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. When set to False, these index files are not generated. That means that client applications will have to use the Address Book Web Query service when searching for contacts.", "title": "EnableFileGeneration", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableFileGeneration" }, "EnableSearchByDialPad": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, users will be able to search for contacts by using their mobile device keypad. This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database.\nThe default value is True ($True).", "title": "EnableSearchByDialPad", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableSearchByDialPad" }, "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" }, "RunTimeOfDay": { "__type_requested": "DateTime", "__type_mapping_type": "DateTime", "description": "Indicates the time of day when the servers generate new Address Book files. The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M..\nThe default value is 01:30:00 (1:30 A.M.).", "title": "RunTimeOfDay", "format": "date-time", "required": false, "readonly": false, "type": "string", "name": "RunTimeOfDay" }, "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" }, "MaxDeltaFileSizePercentage": { "__type_requested": "UInt32", "required": false, "description": "When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server 2015) the Address Book server typically records these changes in a \"delta file,\" a file consisting only of the updated information; Skype for Business can then download the delta files rather than a complete Address Book file. The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. At that point, Lync clients will download the complete file rather than a delta file.\nMaxDeltaFileSizePercentage must be entered as a percentage value, from 1 to 100, inclusive.", "title": "MaxDeltaFileSizePercentage", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxDeltaFileSizePercentage" }, "MaxFileShareThreadCount": { "__type_requested": "Int32", "required": false, "description": "Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. The default value is 300.", "title": "MaxFileShareThreadCount", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxFileShareThreadCount" }, "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": "Unique identifier to be assigned to the new collection of Address Book settings. Because you can only create new collections at the site scope, the Identity will always be the prefix \"site:\" followed by the site name; for example \"site:Redmond\".", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/add/ |
|
The GUI Add form of device/skypeforbusiness/CsAddressBookConfiguration 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/CsAddressBookConfiguration/ | 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/device/skypeforbusiness/CsAddressBookConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsAddressBookConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsAddressBookConfiguration/[pkid1]", "/api/v0/device/skypeforbusiness/CsAddressBookConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsAddressBookConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsAddressBookConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsAddressBookConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsAddressBookConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsAddressBookConfiguration/[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/CsAddressBookConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsAddressBookConfiguration.
GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsAddressBookConfiguration | POST | /api/device/skypeforbusiness/CsAddressBookConfiguration/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/ |
|
The device/skypeforbusiness/CsAddressBookConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsAddressBookConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsAddressBookConfiguration/?skip=0&limit=3&order_by=None&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/CsAddressBookConfiguration/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/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/CsAddressBookConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/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/CsAddressBookConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsAddressBookConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsAddressBookConfiguration", "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": [ { "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/CsAddressBookConfiguration. | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsAddressBookConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsAddressBookConfiguration/[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/CsAddressBookConfiguration/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsAddressBookConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsAddressBookConfiguration | 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/CsAddressBookConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/[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 device/skypeforbusiness/CsAddressBookConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsAddressBookConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsAddressBookConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsAddressBookConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsAddressBookConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |