[Index]
Model ref.: device/skypeforbusiness/CsMobilityPolicy
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": { "RequireWiFiForSharing": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, mobile users must use a WiFi connection in order to participate in an application sharing session. When set to False (the default value) mobile users can participate in application sharing by using either a WiFi connection or a cellular (3G/4G) connection.\nIf this value is set to True, then users then users will not be able to change their sharing configuration settings. If this value is set to False users can use the Options page to modify their sharing configuration settings.", "title": "RequireWiFiForSharing", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireWiFiForSharing" }, "EnableIPAudioVideo": { "__type_requested": "$true | $false", "required": false, "description": "When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. The default value is True, meaning that VoIP calls are allowed.\nThis parameter was introduced in Lync Server 2013.", "title": "EnableIPAudioVideo", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableIPAudioVideo" }, "EnableMobility": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, users are allowed to use Skype for Business Mobile.", "title": "EnableMobility", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableMobility" }, "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide explanatory text to accompany the policy. For example, the Description might include information about the users that the policy should be assigned to.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "AllowCustomerExperienceImprovementProgram": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program.", "title": "AllowCustomerExperienceImprovementProgram", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowCustomerExperienceImprovementProgram" }, "AllowExchangeConnectivity": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device.", "title": "AllowExchangeConnectivity", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowExchangeConnectivity" }, "RequireWIFIForIPAudio": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, the user can use IP audio in calls made when his or her mobile device is connected to a WiFi network. That means that the user will only be allowed to make audio calls using Wi-Fi, and will not be able to use the standard cellular phone network. The default value is False.\nThis parameter was introduced in Lync Server 2013.", "title": "RequireWIFIForIPAudio", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireWIFIForIPAudio" }, "AllowSaveCallLogs": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device.\nNote that this setting does not apply to Android devices.", "title": "AllowSaveCallLogs", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowSaveCallLogs" }, "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 a command 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" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new mobility policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your Skype for Business Online tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID", "title": "Tenant", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Tenant" }, "EnableOutsideVoice": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, enables users to take advantage of Call via Work. When set to False, users cannot use Call via Work.\nThe default value is True.", "title": "EnableOutsideVoice", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableOutsideVoice" }, "AllowSaveIMHistory": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices.", "title": "AllowSaveIMHistory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowSaveIMHistory" }, "RequireWIFIForIPVideo": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. If mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. If this property is set to False (the default value) then the user can make or receive IP video calls in using either a Wi-Fi or a cellular data connection.\nThis parameter was introduced in Lync Server 2013.", "title": "RequireWIFIForIPVideo", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "RequireWIFIForIPVideo" }, "AllowSaveCredentials": { "__type_requested": "$true | $false", "required": false, "description": "When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. This information can then be applied to auto-logon scenarios.", "title": "AllowSaveCredentials", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AllowSaveCredentials" }, "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 Identity to be assigned to the policy. New mobility policies can be created at the site or per-user scope. To create a new site policy, use the prefix \"site:\" and the name of the site as your Identity. For example, use this syntax to create a new policy for the Redmond site:\n-Identity site:Redmond\nTo create a new per-user policy, use an Identity similar to this:\n-Identity SalesDepartmentPolicy\nNote that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsMobilityPolicy cmdlet instead. Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. If you need to make changes to an existing policy, use the Set-CsMobilityPolicy cmdlet.", "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/CsMobilityPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsMobilityPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsMobilityPolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsMobilityPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsMobilityPolicy/?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/CsMobilityPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsMobilityPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsMobilityPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsMobilityPolicy/[pkid1]", "/api/device/skypeforbusiness/CsMobilityPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsMobilityPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsMobilityPolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsMobilityPolicy/[pkid1]", "/api/device/skypeforbusiness/CsMobilityPolicy/[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/CsMobilityPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsMobilityPolicy.
GET http://[host-proxy]/api/device/skypeforbusiness/CsMobilityPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsMobilityPolicy | POST | /api/device/skypeforbusiness/CsMobilityPolicy/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/CsMobilityPolicy/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/CsMobilityPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsMobilityPolicy/ |
|
The device/skypeforbusiness/CsMobilityPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsMobilityPolicy instances)
{ "operations": [ "cs_mobility_policy", "move" ], "pagination": { "direction": "asc", "order_by": "Identity", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsMobilityPolicy/?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/CsMobilityPolicy/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/CsMobilityPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/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/CsMobilityPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "cs_mobility_policy": { "support_async": true, "class": "custom", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/+cs_mobility_policy/?hierarchy=[hierarchy]", "method": "POST", "title": "Cs Mobility Policy" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsMobilityPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsMobilityPolicy", "model_specific_actions": [ "list", "get", "cs_mobility_policy", "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/CsMobilityPolicy. | GET | /api/device/skypeforbusiness/CsMobilityPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsMobilityPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsMobilityPolicy/[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/CsMobilityPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsMobilityPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsMobilityPolicy | 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/CsMobilityPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsMobilityPolicy/[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/CsMobilityPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsMobilityPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsMobilityPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsMobilityPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsMobilityPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |