API Reference for device/skypeforbusinesshybrid/CsUserServicesConfiguration

Model ref.: device/skypeforbusinesshybrid/CsUserServicesConfiguration

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "MaxSubscriptions": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "The maximum number of SIP subscribe dialogs that a user can have open at any one time. A subscribe dialog represents a request for SIP resources. The default value is 200.", 
               "title": "MaxSubscriptions", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MaxSubscriptions"
          }, 
          "MaintenanceTimeOfDay": {
               "__type_requested": "DateTime", 
               "__type_mapping_type": "DateTime", 
               "description": "Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value. You can use either the 24-hour format (for example, \"14:00\") or the 12-hour format (for example, \"2:00 PM\").\nThe default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00).", 
               "title": "MaintenanceTimeOfDay", 
               "format": "date-time", 
               "required": false, 
               "readonly": false, 
               "type": "string", 
               "name": "MaintenanceTimeOfDay"
          }, 
          "PresenceProviders": {
               "__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider]", 
               "required": false, 
               "description": "Collection of presence providers for the new User Service configuration settings. Presence providers are best added to a collection of User Service configuration settings by using the New-CsPresenceProvider cmdlet.", 
               "title": "PresenceProviders", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "PresenceProviders"
          }, 
          "DeactivationGracePeriod": {
               "__type_requested": "timespan", 
               "required": false, 
               "description": "The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days.hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2.12:00:00 (2 days. 12 hours: 00 minutes: 00 seconds.)\nThe DeactivationGracePeriod must be between 8 hours and 365 days, inclusive. The default value is 1 day (1.00:00:00).", 
               "title": "DeactivationGracePeriod", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "DeactivationGracePeriod"
          }, 
          "AllowNonRoomSystemNotification": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "PARAMVALUE: $true | $false", 
               "title": "AllowNonRoomSystemNotification", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AllowNonRoomSystemNotification"
          }, 
          "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"
          }, 
          "MinSubscriptionExpiration": {
               "__type_requested": "Int64", 
               "required": false, 
               "description": "Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds.\nThe minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 1200 seconds (20 minutes).", 
               "title": "MinSubscriptionExpiration", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MinSubscriptionExpiration"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "Unique identifier for the User Services configuration settings to be created. To create settings at the site scope, use syntax similar to this:\n-Identity site:Redmond\nTo create settings at the service level, use syntax like this:\n-Identity service:UserServer:atl-cs-001.litwareinc.com", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "MaxContacts": {
               "__type_requested": "uint16", 
               "required": false, 
               "description": "The maximum number of contacts a user can have; the default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts.", 
               "title": "MaxContacts", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "MaxContacts"
          }, 
          "MaxSubscriptionExpiration": {
               "__type_requested": "Int64", 
               "required": false, 
               "description": "Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. For example, if the maximum time is set to 28800 seconds and a client requests a timeout interval of 86400 seconds, the client will be given the maximum allowed expiration period: 28800 seconds.\nThe maximum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 43200 seconds (12 hours).", 
               "title": "MaxSubscriptionExpiration", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxSubscriptionExpiration"
          }, 
          "MaxPersonalNotes": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the maximum number of personal notes that are stored in the user's note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10.", 
               "title": "MaxPersonalNotes", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxPersonalNotes"
          }, 
          "AnonymousUserGracePeriod": {
               "__type_requested": "timespan", 
               "required": false, 
               "description": "Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting without an authenticated user being present in that same meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. This setting applies to both scheduled meetings and to ad-hoc meetings created by clicking Meet Now in Microsoft Lync.\nThe AnonymousUserGracePeriod must be specified using the following format: days.hours:minutes:seconds (for example, 0.00:30:00 for 30 minutes). The grace period can be set to any value between 0 second and 1 day; the default value is 90 minutes (01:30:00).", 
               "title": "AnonymousUserGracePeriod", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "AnonymousUserGracePeriod"
          }, 
          "SubscribeToCollapsedDG": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. This enables the client to maintain up-to-minute presence information for each member of the group. If set to False, client applications will not be allowed to subscribe to \"collapsed\" groups.", 
               "title": "SubscribeToCollapsedDG", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "SubscribeToCollapsedDG"
          }, 
          "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"
          }, 
          "DefaultSubscriptionExpiration": {
               "__type_requested": "Int64", 
               "required": false, 
               "description": "Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property.\nThe default subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. The default value is 28800 seconds (8 hours).", 
               "title": "DefaultSubscriptionExpiration", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "DefaultSubscriptionExpiration"
          }, 
          "MaxScheduledMeetingsPerOrganizer": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000. This means that, if a user is already the organizer for 1000 meetings, his or her attempt to schedule a new meeting (meeting number 1001) will fail.", 
               "title": "MaxScheduledMeetingsPerOrganizer", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxScheduledMeetingsPerOrganizer"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusinesshybrid/CsUserServicesConfiguration 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/CsUserServicesConfiguration/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/CsUserServicesConfiguration/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/skypeforbusinesshybrid/CsUserServicesConfiguration
```
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/skypeforbusinesshybrid/CsUserServicesConfiguration device/skypeforbusinesshybrid/CsUserServicesConfiguration schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json

The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsUserServicesConfiguration	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsUserServicesConfiguration	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsUserServicesConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[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/CsUserServicesConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsUserServicesConfiguration.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/skypeforbusinesshybrid/CsUserServicesConfiguration:

 GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsUserServicesConfiguration	POST	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/skypeforbusinesshybrid/CsUserServicesConfiguration	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusinesshybrid/CsUserServicesConfiguration schema and all instances as JSON.

(The list will return 0 to 3 device/skypeforbusinesshybrid/CsUserServicesConfiguration instances)

GET http://[host]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": null, 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?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/CsUserServicesConfiguration/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/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/CsUserServicesConfiguration", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/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/CsUserServicesConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusinesshybrid/CsUserServicesConfiguration", 
          "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/skypeforbusinesshybrid/CsUserServicesConfiguration.	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusinesshybrid/CsUserServicesConfiguration as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[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/CsUserServicesConfiguration/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/skypeforbusinesshybrid/CsUserServicesConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsUserServicesConfiguration	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/CsUserServicesConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusinesshybrid/CsUserServicesConfiguration instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/skypeforbusinesshybrid/CsUserServicesConfiguration.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/skypeforbusinesshybrid/CsUserServicesConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/skypeforbusinesshybrid/CsUserServicesConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge