API Reference for device/skypeforbusinesshybrid/CsProxyConfiguration

Model ref.: device/skypeforbusinesshybrid/CsProxyConfiguration

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/CsProxyConfiguration/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "Realm": {
               "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.IRealmChoice", 
               "required": false, 
               "description": "Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communications Service) or by a custom realm. Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet.", 
               "title": "Realm", 
               "__type_mapping_type": "Unknown", 
               "readonly": true, 
               "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", 
               "type": "string", 
               "name": "Realm"
          }, 
          "MaxClientCompressionCount": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. The compression count can be set to any integer value between 0 and 65535, inclusive. The default value is 15000.", 
               "title": "MaxClientCompressionCount", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxClientCompressionCount"
          }, 
          "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"
          }, 
          "OutgoingTlsCount": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. The minimum number of TLS connections is 1, and the maximum number is 4. By default, OutgoingTlsCount is set to 4.", 
               "title": "OutgoingTlsCount", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "OutgoingTlsCount"
          }, 
          "MaxKeepAliveInterval": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. The default value is 20 minutes.", 
               "title": "MaxKeepAliveInterval", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxKeepAliveInterval"
          }, 
          "LoadBalanceInternalServers": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When True, software load balancing is employed for requests to Registrars and other internal servers. The default value is true ($True).", 
               "title": "LoadBalanceInternalServers", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "LoadBalanceInternalServers"
          }, 
          "AllowPartnerPollingSubscribes": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set the True, partner applications are allowed to periodically poll the service for state changes. The default value is False ($False).", 
               "title": "AllowPartnerPollingSubscribes", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AllowPartnerPollingSubscribes"
          }, 
          "DnsCacheRecordCount": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Maximum number of records that can be maintained in the DNS record cache. The default value is 3000.", 
               "title": "DnsCacheRecordCount", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "DnsCacheRecordCount"
          }, 
          "AcceptServerCompression": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), the proxy server will accept all incoming compression requests from other servers.", 
               "title": "AcceptServerCompression", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AcceptServerCompression"
          }, 
          "RequestServerCompression": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers.", 
               "title": "RequestServerCompression", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "RequestServerCompression"
          }, 
          "AcceptClientCompression": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints.", 
               "title": "AcceptClientCompression", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "AcceptClientCompression"
          }, 
          "Identity": {
               "__type_requested": "string", 
               "required": true, 
               "description": "Unique identifier for the proxy server configuration settings to be created. Proxy server configuration settings can only be created at the service scope, and only for the Edge Server and Registrar services. You cannot create settings at the global scope; likewise, you cannot create settings at the service scope if the service in question already hosts a collection of proxy server settings. For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts proxy server settings, then any command that attempts to create new settings for that service will fail.\nTo specify the Identity for your new proxy server settings, use syntax similar to this:\n-Identity \"service:Registrar:atl-cs-001.litwareinc.com\"", 
               "title": "Identity", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "Identity"
          }, 
          "UseCertificateForClientToProxyAuth": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), client endpoints will be allowed to use certificates for authentication.", 
               "title": "UseCertificateForClientToProxyAuth", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UseCertificateForClientToProxyAuth"
          }, 
          "EnableWhiteSpaceKeepAlive": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), the proxy server expects clients to periodically send a \"whitespace message\" (an empty message with no content) to indicate that the connection is still active.", 
               "title": "EnableWhiteSpaceKeepAlive", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableWhiteSpaceKeepAlive"
          }, 
          "TreatAllClientsAsRemote": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server running the Access Edge service. The default value is False.", 
               "title": "TreatAllClientsAsRemote", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "TreatAllClientsAsRemote"
          }, 
          "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"
          }, 
          "UseKerberosForClientToProxyAuth": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server.", 
               "title": "UseKerberosForClientToProxyAuth", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UseKerberosForClientToProxyAuth"
          }, 
          "TestParameterList": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not currently used by Skype for Business Server 2015.", 
               "title": "TestParameterList", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "TestParameterList"
          }, 
          "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"
          }, 
          "UseNtlmForClientToProxyAuth": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. That is not true for Kerberos authentication.", 
               "title": "UseNtlmForClientToProxyAuth", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "UseNtlmForClientToProxyAuth"
          }, 
          "SpecialConfigurationList": {
               "__type_requested": "String", 
               "required": false, 
               "description": "PARAMVALUE: String", 
               "title": "SpecialConfigurationList", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "SpecialConfigurationList"
          }, 
          "MaxServerMessageBodySizeKb": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "The maximum-allowed size (in kilobytes) for the body of a message sent from another server. The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. The server message body size can be set to any integer value between 1000 and 20000, inclusive.", 
               "title": "MaxServerMessageBodySizeKb", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxServerMessageBodySizeKb"
          }, 
          "LoadBalanceEdgeServers": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When True, software load balancing is employed for requests to Edge Servers. The default value is True ($True).", 
               "title": "LoadBalanceEdgeServers", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "LoadBalanceEdgeServers"
          }, 
          "DisableNtlmFor2010AndLaterClients": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. The default value is False.", 
               "title": "DisableNtlmFor2010AndLaterClients", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "DisableNtlmFor2010AndLaterClients"
          }, 
          "EnableLoggingAllMessageBodies": {
               "__type_requested": "$true | $false", 
               "required": false, 
               "description": "When set to True, Microsoft Lync Server will log the actual content of all instant messages. For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files.\nThe default value is False.", 
               "title": "EnableLoggingAllMessageBodies", 
               "__type_mapping_type": "Boolean", 
               "readonly": false, 
               "type": "boolean", 
               "name": "EnableLoggingAllMessageBodies"
          }, 
          "TestFeatureList": {
               "__type_requested": "String", 
               "required": false, 
               "description": "This parameter is not currently used by Skype for Business Server 2015.", 
               "title": "TestFeatureList", 
               "__type_mapping_type": "String", 
               "readonly": false, 
               "type": "string", 
               "name": "TestFeatureList"
          }, 
          "MaxServerCompressionCount": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. The server compression count can be set to any integer value between 0 and 65535, inclusive. The default value is 1024.", 
               "title": "MaxServerCompressionCount", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxServerCompressionCount"
          }, 
          "MaxClientMessageBodySizeKb": {
               "__type_requested": "UInt32", 
               "required": false, 
               "description": "The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. The client message body size can be set to any integer value between 64 and 256, inclusive.", 
               "title": "MaxClientMessageBodySizeKb", 
               "__type_mapping_type": "Integer", 
               "readonly": false, 
               "type": "integer", 
               "name": "MaxClientMessageBodySizeKb"
          }
     }, 
     "schema_version": "1150"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/skypeforbusinesshybrid/CsProxyConfiguration 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/CsProxyConfiguration/	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/CsProxyConfiguration/	hierarchy=[hierarchy]	{"hrefs":["/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration
```
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsProxyConfiguration/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/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/CsProxyConfiguration device/skypeforbusinesshybrid/CsProxyConfiguration schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsProxyConfiguration/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration/?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/CsProxyConfiguration	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsProxyConfiguration	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration/?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/CsProxyConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[pkid1]", "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsProxyConfiguration.

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

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

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

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/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/CsProxyConfiguration/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/CsProxyConfiguration/	hierarchy=[hierarchy] format=json schema=true	The device/skypeforbusinesshybrid/CsProxyConfiguration schema and all instances as JSON.

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

GET http://[host]/api/device/skypeforbusinesshybrid/CsProxyConfiguration/?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/CsProxyConfiguration/?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/CsProxyConfiguration/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/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/CsProxyConfiguration", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/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/CsProxyConfiguration/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/skypeforbusinesshybrid/CsProxyConfiguration/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/skypeforbusinesshybrid/CsProxyConfiguration", 
          "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/CsProxyConfiguration.	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/skypeforbusinesshybrid/CsProxyConfiguration 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/CsProxyConfiguration/[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/CsProxyConfiguration/[pkid]/	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsProxyConfiguration/?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/CsProxyConfiguration	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/CsProxyConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/skypeforbusinesshybrid/CsProxyConfiguration/[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/CsProxyConfiguration/[pkid]/	hierarchy=[hierarchy]	The device/skypeforbusinesshybrid/CsProxyConfiguration instance with [pkid].

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

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

API Reference for device/skypeforbusinesshybrid/CsProxyConfiguration

GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsProxyConfiguration/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/CsProxyConfiguration/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge