[Index]
Model ref.: device/skypeforbusinesshybrid/CsConversationHistoryConfiguration
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": { "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" }, "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" }, "EnableServerConversationHistory": { "__type_requested": "bool", "required": true, "name": "EnableServerConversationHistory", "title": "EnableServerConversationHistory", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "When set to True ($True), conversation histories and related information will be stored on the server. The default value is False, which means that this information is stored in user mailboxes." }, "EnableDisplayNameResolution": { "__type_requested": "bool", "required": true, "name": "EnableDisplayNameResolution", "title": "EnableDisplayNameResolution", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "PARAMVALUE: $true | $false" }, "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" }, "MaxContinuedConversationRetry": { "__type_requested": "uint32", "required": true, "name": "MaxContinuedConversationRetry", "title": "MaxContinuedConversationRetry", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "Specifies the maximum number of times the Skype for Business Server will search for a previous conversation item from Exchange to create a continued conversation. If the previous conversation is not found in the specified number of attempts, a new conversation is created. Increasing this value will present more continued conversations, but at the cost of decreased performance. This parameter should not be used except in situations where Exchange connections are known to be unreliable. The default value is 3." }, "Identity": { "__type_requested": "string", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Unique Identity of the conversation history configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsConversationHistoryConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings:\n-Identity \"global\"" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?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/CsConversationHistoryConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsConversationHistoryConfiguration |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsConversationHistoryConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[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/CsConversationHistoryConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsConversationHistoryConfiguration.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsConversationHistoryConfiguration | POST | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/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/CsConversationHistoryConfiguration/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/CsConversationHistoryConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/ |
|
The device/skypeforbusinesshybrid/CsConversationHistoryConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsConversationHistoryConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?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": [ { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/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/CsConversationHistoryConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/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/CsConversationHistoryConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsConversationHistoryConfiguration", "model_specific_actions": [ "get", "list", "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/CsConversationHistoryConfiguration. | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsConversationHistoryConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[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/CsConversationHistoryConfiguration/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsConversationHistoryConfiguration | 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/CsConversationHistoryConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[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/CsConversationHistoryConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsConversationHistoryConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsConversationHistoryConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsConversationHistoryConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsConversationHistoryConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |