[Index]
Model ref.: device/skypeforbusiness/CsArchivingConfiguration
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": { "CachePurgingInterval": { "__type_requested": "UInt32", "required": false, "description": "Indicates how often (in hours) the system is purged of transcripts where none of the participants have been enabled for archiving. By design, all group IM sessions and conferencing sessions are recorded when they take place. At the specified interval, the system will determine whether any of the participants in these sessions have been enabled for archiving. If the system finds a session where none of the participants have been enabled for archiving, then that transcript will be deleted from the database.\nThe CachePurgeInterval property can be set to any integer value between 4 and 168, inclusive. The default value is 24.", "title": "CachePurgingInterval", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "CachePurgingInterval" }, "BlockOnArchiveFailure": { "__type_requested": "$true | $false", "required": false, "description": "If True, then the IM service will be suspended any time your instant message sessions cannot be archived. If set to False (the default value), instant messaging will continue even if sessions cannot be archived.", "title": "BlockOnArchiveFailure", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "BlockOnArchiveFailure" }, "PurgeExportedArchivesOnly": { "__type_requested": "$true | $false", "required": false, "description": "If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). Instant messages that have not been exported will remain in the database, even if those messages are older than the value specified by the KeepArchivingDataForDays property.", "title": "PurgeExportedArchivesOnly", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "PurgeExportedArchivesOnly" }, "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" }, "EnablePurging": { "__type_requested": "$true | $false", "required": false, "description": "If True, archived instant messages will periodically be removed from the database, provided that these instant messages: 1) are older than the value specified in the KeepArchivingDataForDays property; or, 2) have been exported and marked for deletion.\nIf False, instant messages will not be automatically deleted from the database.", "title": "EnablePurging", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnablePurging" }, "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" }, "EnableArchiving": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.EnableArchiving", "required": false, "description": "Indicates which items (if any) are saved to the archiving database. Valid values are:\nNone. No items are archived to the database. This is the default value.\nImOnly. IM sessions are archived to the database.\nImAndWebConf. Both IM and web conferencing sessions are archived to the database.", "title": "EnableArchiving", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "EnableArchiving" }, "EnableExchangeArchiving": { "__type_requested": "$true | $false", "required": false, "description": "When set to True, Skype for Business Server 2015 instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server 2015 archiving policies.\nThe default value is False.", "title": "EnableExchangeArchiving", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnableExchangeArchiving" }, "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" }, "PurgeHourOfDay": { "__type_requested": "UInt32", "required": false, "description": "Indicates the time of day when expired records are deleted from the archiving database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. Note that you can only specify the hour of the day. This means that you can schedule purging to take place at 4:00 AM, but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. The default value is 2 (2:00 AM).\nDatabase purging takes place only if the EnablePurging property is set to True.", "title": "PurgeHourOfDay", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "PurgeHourOfDay" }, "KeepArchivingDataForDays": { "__type_requested": "UInt32", "required": false, "description": "Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. The default value is 14.\nThis property takes effect only if EnablePurging has been set to True.", "title": "KeepArchivingDataForDays", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "name": "KeepArchivingDataForDays" }, "Identity": { "__type_requested": "string", "required": true, "description": "Unique identifier to be assigned to the new collection of archiving configuration settings. In Skype for Business Server 2015 you can create new collections at the site scope or at the service scope. To create new settings at the site scope, use syntax similar to this:\n-Identity \"site:Redmond\"\nTo create settings at the service scope (for the Registrar service only) use syntax like this:\n-Identity \"service:Registrar:atl-cs-001.litwareinc.com\"", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "ArchiveDuplicateMessages": { "__type_requested": "$true | $false", "required": false, "description": "Specifies how cross-pool instant messages should be archived. For example, Ken Myer (with an account in Pool 1) sends an instant message to Pilar Ackerman (who has an account in Pool 2). Pilar, in turn, sends a reply to Ken's instant message. If ArchiveDuplicateMessages is set to False, then (based on a built-in algorithm) the session transcript will be logged in either Pool 1 or Pool 2, but not both. If ArchiveDuplicateMessages is set to True (the default value), the transcript will be logged in both pools.", "title": "ArchiveDuplicateMessages", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "ArchiveDuplicateMessages" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/add/ |
|
The GUI Add form of device/skypeforbusiness/CsArchivingConfiguration 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/skypeforbusiness/CsArchivingConfiguration/ | 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/skypeforbusiness/CsArchivingConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsArchivingConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsArchivingConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsArchivingConfiguration/[pkid1]", "/api/v0/device/skypeforbusiness/CsArchivingConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsArchivingConfiguration/?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/CsArchivingConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsArchivingConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsArchivingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsArchivingConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsArchivingConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsArchivingConfiguration/[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/CsArchivingConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsArchivingConfiguration.
GET http://[host-proxy]/api/device/skypeforbusiness/CsArchivingConfiguration/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsArchivingConfiguration | POST | /api/device/skypeforbusiness/CsArchivingConfiguration/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/CsArchivingConfiguration/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/CsArchivingConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/ |
|
The device/skypeforbusiness/CsArchivingConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsArchivingConfiguration instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsArchivingConfiguration/?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/skypeforbusiness/CsArchivingConfiguration/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/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/CsArchivingConfiguration", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/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/CsArchivingConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsArchivingConfiguration/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsArchivingConfiguration", "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": "19.3.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsArchivingConfiguration. | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsArchivingConfiguration as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsArchivingConfiguration/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsArchivingConfiguration | 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/CsArchivingConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/[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/CsArchivingConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsArchivingConfiguration.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsArchivingConfiguration instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsArchivingConfiguration. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsArchivingConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |