[Index]
Model ref.: device/skypeforbusinesshybrid/CsPersistentChatConfiguration
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": { "RoomManagementUrl": { "__type_requested": "String", "required": false, "description": "URL for the Web page that administrators can use to manage individual chat rooms.", "title": "RoomManagementUrl", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "RoomManagementUrl" }, "MaxFileSizeKB": { "__type_requested": "UInt32", "required": false, "description": "Maximum size of a file (in kilobytes) that can be uploaded or downloaded by the web service. The default value is 20000 KB.", "title": "MaxFileSizeKB", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "MaxFileSizeKB" }, "DefaultChatHistory": { "__type_requested": "int16", "required": false, "description": "Default number of chat messages instantly available in a chat room. Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved.\nDefaultChatHistory can be set to any value between 1 and 500, inclusive. The default value is 30.", "title": "DefaultChatHistory", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "DefaultChatHistory" }, "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" }, "ParticipantUpdateLimit": { "__type_requested": "UInt32", "required": false, "description": "Maximum number of users who can participate in a chat room before the active participant list updates are disabled. The default value is 75.", "title": "ParticipantUpdateLimit", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "ParticipantUpdateLimit" }, "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 for the new Persistent Chat configuration settings being created. New configuration settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). To create new settings at the site scope, use syntax similar to this:\n-Identity \"site:Redmond\"\nTo create new settings at the service scope, use syntax like this:\n-Identity \"service:PersistentChatServer:atl-gc-001.litwarein.com\"", "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/skypeforbusinesshybrid/CsPersistentChatConfiguration/add/ |
|
The GUI Add form of device/skypeforbusinesshybrid/CsPersistentChatConfiguration 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/skypeforbusinesshybrid/CsPersistentChatConfiguration/ | 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/skypeforbusinesshybrid/CsPersistentChatConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsPersistentChatConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsPersistentChatConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsPersistentChatConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[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/skypeforbusinesshybrid/CsPersistentChatConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsPersistentChatConfiguration.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsPersistentChatConfiguration | POST | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/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/skypeforbusinesshybrid/CsPersistentChatConfiguration/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/ |
|
The device/skypeforbusinesshybrid/CsPersistentChatConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsPersistentChatConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?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/skypeforbusinesshybrid/CsPersistentChatConfiguration/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/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/skypeforbusinesshybrid/CsPersistentChatConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/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/skypeforbusinesshybrid/CsPersistentChatConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsPersistentChatConfiguration", "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/skypeforbusinesshybrid/CsPersistentChatConfiguration. | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsPersistentChatConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsPersistentChatConfiguration | 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/skypeforbusinesshybrid/CsPersistentChatConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[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/skypeforbusinesshybrid/CsPersistentChatConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsPersistentChatConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsPersistentChatConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsPersistentChatConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsPersistentChatConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |