[Index]
Model ref.: device/skypeforbusiness/CsPresencePolicy
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": { "Description": { "__type_requested": "String", "required": false, "description": "Enables administrators to provide additional text to accompany a presence policy. For example, the Description might include information about the users the policy should be assigned to.", "title": "Description", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Description" }, "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" }, "Identity": { "__type_requested": "string", "required": true, "description": "Unique identifier for the new presence policy. To create a new per-user policy, use syntax similar to this:\n-Identity \"RedmondPresencePolicy\"\nTo create a new policy at the site scope, use syntax similar to this:\n-Identity \"site:Redmond\"\nNote that you cannot create a new presence policy at the global scope. In addition, your command will fail if the site in question already hosts a presence policy, or if you try to use the Identity of a per-user policy that already exists.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "MaxPromptedSubscriber": { "__type_requested": "uint16", "required": false, "description": "The maximum number of promoted subscribers a user can have at any one time. By default, any time you are added to another user's Contacts list a notification dialog appears on screen informing you of this fact, and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber.\nMaxPromptedSubscriber can be set to any integer value between 0 and 600, inclusive; the default value is 200. If you set this value to 0, users will not receive any notifications when they are added to another user's Contacts list.", "title": "MaxPromptedSubscriber", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "MaxPromptedSubscriber" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new presence 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" }, "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" }, "MaxCategorySubscription": { "__type_requested": "uint16", "required": false, "description": "The maximum number of category subscriptions allowed at any one time. A category subscription represents a request for a specific category of information; for example, an application that requests calendar data.\nMaxCategorySubscription can be set to any integer value between 0 and 3000; the default value is 1000.", "title": "MaxCategorySubscription", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "MaxCategorySubscription" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsPresencePolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsPresencePolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsPresencePolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsPresencePolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsPresencePolicy/?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/CsPresencePolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPresencePolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsPresencePolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPresencePolicy/[pkid1]", "/api/device/skypeforbusiness/CsPresencePolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsPresencePolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsPresencePolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsPresencePolicy/[pkid1]", "/api/device/skypeforbusiness/CsPresencePolicy/[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/CsPresencePolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPresencePolicy.
GET http://[host-proxy]/api/device/skypeforbusiness/CsPresencePolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsPresencePolicy | POST | /api/device/skypeforbusiness/CsPresencePolicy/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/CsPresencePolicy/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/CsPresencePolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsPresencePolicy/ |
|
The device/skypeforbusiness/CsPresencePolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsPresencePolicy instances)
{ "operations": [ "cs_presence_policy", "move" ], "pagination": { "direction": "asc", "order_by": "Identity", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsPresencePolicy/?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/CsPresencePolicy/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/CsPresencePolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsPresencePolicy/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/CsPresencePolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsPresencePolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsPresencePolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsPresencePolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsPresencePolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "cs_presence_policy": { "support_async": true, "class": "custom", "href": "/api/device/skypeforbusiness/CsPresencePolicy/+cs_presence_policy/?hierarchy=[hierarchy]", "method": "POST", "title": "Cs Presence Policy" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsPresencePolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsPresencePolicy", "model_specific_actions": [ "list", "get", "cs_presence_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/CsPresencePolicy. | GET | /api/device/skypeforbusiness/CsPresencePolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsPresencePolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsPresencePolicy/[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/CsPresencePolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsPresencePolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsPresencePolicy | 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/CsPresencePolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsPresencePolicy/[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/CsPresencePolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPresencePolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsPresencePolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsPresencePolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsPresencePolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |