[Index]
Model ref.: device/skypeforbusiness/CsPersistentChatPolicy
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": { "EnablePersistentChat": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, users affected by the policy will be allowed to use Persistent Chat. When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat.", "title": "EnablePersistentChat", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnablePersistentChat" }, "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 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 to be assigned to the policy. New Persistent Chat policies can be created at the site scope or the 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 SalesPersistentChatPolicy\nNote that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsPersistentChatPolicy 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-CsPersistentChatPolicy cmdlet.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "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" }, "Tenant": { "__type_requested": "Guid", "required": false, "description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new Persistent Chat 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" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsPersistentChatPolicy/[pkid1]", "/api/v0/device/skypeforbusiness/CsPersistentChatPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsPersistentChatPolicy/?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/CsPersistentChatPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsPersistentChatPolicy |
|
{"hrefs": ["/api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid1]", "/api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsPersistentChatPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid1]", "/api/device/skypeforbusiness/CsPersistentChatPolicy/[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/CsPersistentChatPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPersistentChatPolicy.
GET http://[host-proxy]/api/device/skypeforbusiness/CsPersistentChatPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsPersistentChatPolicy | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/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/CsPersistentChatPolicy/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/CsPersistentChatPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/ |
|
The device/skypeforbusiness/CsPersistentChatPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsPersistentChatPolicy instances)
{ "operations": [ "cs_persistent_chat_policy", "move" ], "pagination": { "direction": "asc", "order_by": "Identity", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsPersistentChatPolicy/?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/CsPersistentChatPolicy/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/CsPersistentChatPolicy", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/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/CsPersistentChatPolicy/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "cs_persistent_chat_policy": { "support_async": true, "class": "custom", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/+cs_persistent_chat_policy/?hierarchy=[hierarchy]", "method": "POST", "title": "Cs Persistent Chat Policy" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsPersistentChatPolicy/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsPersistentChatPolicy", "model_specific_actions": [ "list", "get", "cs_persistent_chat_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": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsPersistentChatPolicy. | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsPersistentChatPolicy as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsPersistentChatPolicy/[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/CsPersistentChatPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsPersistentChatPolicy/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsPersistentChatPolicy | 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/CsPersistentChatPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/[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/CsPersistentChatPolicy and the JSON format can be used to import instances of device/skypeforbusiness/CsPersistentChatPolicy.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsPersistentChatPolicy instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsPersistentChatPolicy. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Move | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsPersistentChatPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |