[Index]
Model ref.: device/skypeforbusiness/CsWebServiceConfiguration
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": {
"MaxCSRKeySize": {
"__type_requested": "uint64",
"required": false,
"description": "Sets the maximum size of the certificate signing request (CSR) key. (A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. The default value is 16384.",
"title": "MaxCSRKeySize",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MaxCSRKeySize"
},
"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"
},
"ShowDownloadCommunicatorAttendeeLink": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter has been deprecated for use with the on-premises version of Skype for Business Server 2015.\nIf set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them toward a download for Skype for Business Web App.",
"title": "ShowDownloadCommunicatorAttendeeLink",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowDownloadCommunicatorAttendeeLink"
},
"UseCertificateAuth": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True (the default value), clients can be authenticated using certificates. Set this value to False ($False) to disable certificate authentication.",
"title": "UseCertificateAuth",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "UseCertificateAuth"
},
"EnableCertChainDownload": {
"__type_requested": "$true | $false",
"required": false,
"description": "If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted.",
"title": "EnableCertChainDownload",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableCertChainDownload"
},
"WsFedPassiveMetadataUri": {
"__type_requested": "String",
"required": false,
"description": "URI used by the WS-federation Web requestor protocol.",
"title": "WsFedPassiveMetadataUri",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "WsFedPassiveMetadataUri"
},
"MobilePreferredAuthType": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.Web.MobilePreferredAuthType",
"required": false,
"description": "PARAMVALUE: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth",
"title": "MobilePreferredAuthType",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MobilePreferredAuthType"
},
"UsePinAuth": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). Set this value to False ($False) to disable PIN authentication.",
"title": "UsePinAuth",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "UsePinAuth"
},
"TrustedCACerts": {
"__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.Web.CACertId]",
"required": false,
"description": "Collection of certificates representing certificate chains trusted by the Web server. New certificates added to the collection must be created using the New-CsWebTrustedCACertificate cmdlet.\nThis collection is not used if the InferCertChainFromSSL property is set to True.",
"title": "TrustedCACerts",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "TrustedCACerts"
},
"EnableMediaBasicAuth": {
"__type_requested": "$true | $false",
"required": false,
"description": "PARAMVALUE: $true | $false",
"title": "EnableMediaBasicAuth",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableMediaBasicAuth"
},
"HstsMaxAgeInSeconds": {
"__type_requested": "Int64",
"required": false,
"description": "PARAMVALUE: Int64",
"title": "HstsMaxAgeInSeconds",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "HstsMaxAgeInSeconds"
},
"SecondaryLocationSourceUrl": {
"__type_requested": "String",
"required": false,
"description": "URL for a Web service that can process a location request. This service is typically used only when location requests cannot be resolved locally.",
"title": "SecondaryLocationSourceUrl",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SecondaryLocationSourceUrl"
},
"Identity": {
"__type_requested": "string",
"required": true,
"description": "Unique identifier for the Web Services configuration settings to be created. To create settings configured at the site scope, use syntax similar to this:\n-Identity \"site:Redmond\"\nTo create settings configured at the service scope, use syntax similar to this:\n-Identity \"service:WebServer:atl-cs-001.litwareinc.com\"\nNote that any settings created at the service scope must be assigned to the Web Server service.",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Identity"
},
"ShowAlternateJoinOptionsExpanded": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter has been deprecated for use with the on-premises version of Skype for Business Server 2015.\nWhen set to True then alternate options for joining an online conference will automatically be expanded and shown to users. When set to False (the default value) these options will be available, but the user will have to display the list of options for themselves.",
"title": "ShowAlternateJoinOptionsExpanded",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowAlternateJoinOptionsExpanded"
},
"MinValidityPeriodHours": {
"__type_requested": "uint64",
"required": false,
"description": "When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. MinValidityPeriodHours represents the minimum amount of time a client can request.\nMinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). The default value is 8.",
"title": "MinValidityPeriodHours",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MinValidityPeriodHours"
},
"MinCSRKeySize": {
"__type_requested": "uint64",
"required": false,
"description": "Sets the minimum size of the CSR key. The minimum size can be set to any integer value between 1024 and 16384 bytes. The default value is 16384.",
"title": "MinCSRKeySize",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MinCSRKeySize"
},
"CASigningKeyLength": {
"__type_requested": "uint64",
"required": false,
"description": "Sets the size of the certification authority (CA) signing key, the private key used by a CA to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048.",
"title": "CASigningKeyLength",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "CASigningKeyLength"
},
"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"
},
"ShowJoinUsingLegacyClientLink": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter has been deprecated for use with the on-premises version of Skype for Business Server 2015.\nIf set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. The default value is False.",
"title": "ShowJoinUsingLegacyClientLink",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowJoinUsingLegacyClientLink"
},
"AutoLaunchLyncWebAccess": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter has been deprecated for use with the on-premises version of Skype for Business Server 2015.\nWhen set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed, and Internet Explorer is not blocking pop-up windows) have been met.\nThe default value is True.",
"title": "AutoLaunchLyncWebAccess",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AutoLaunchLyncWebAccess"
},
"EnableGroupExpansion": {
"__type_requested": "$true | $false",
"required": false,
"description": "If set to True, group expansion will be enabled in Skype for Business. With group expansion, users can configure a distribution group as a contact, and then \"expand\" that group. When a group has been expanded, users can see all the individual members of a group and their current presence information.",
"title": "EnableGroupExpansion",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableGroupExpansion"
},
"EnableStatisticsInResponse": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. The default value is False ($False).",
"title": "EnableStatisticsInResponse",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableStatisticsInResponse"
},
"MACResolverUrl": {
"__type_requested": "String",
"required": false,
"description": "URL for a Web service capable of performing Media Access Control (MAC) resolution. MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. MAC resolution is used by the Enhanced 9-1-1 service.",
"title": "MACResolverUrl",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MACResolverUrl"
},
"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"
},
"UseWebClientLegacyUI": {
"__type_requested": "$true | $false",
"required": false,
"description": "PARAMVALUE: $true | $false",
"title": "UseWebClientLegacyUI",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "UseWebClientLegacyUI"
},
"AllowExternalAuthentication": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True (the default value), OAuth authentication can be used to authenticate external users.",
"title": "AllowExternalAuthentication",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AllowExternalAuthentication"
},
"CrossDomainAuthorizationList": {
"__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Settings.Web.Origin]",
"required": false,
"description": "Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server 2015 deployment.\nDomains to be added to the list must be created using the New-CsWebOrigin cmdlet and then added to the new collection of Web service configuration settings. Domain names must be prefaced using the http: or the https: prefix. See Example 3 of this help topic for more information.\nThis parameter was introduced in the February, 2013 release of Lync Server 2013.",
"title": "CrossDomainAuthorizationList",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "CrossDomainAuthorizationList"
},
"InferCertChainFromSSL": {
"__type_requested": "$true | $false",
"required": false,
"description": "If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted.",
"title": "InferCertChainFromSSL",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "InferCertChainFromSSL"
},
"UseWindowsAuth": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.Web.UseWindowsAuth",
"required": false,
"description": "Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. Valid values are:\nNegotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM).\nNTLM - Windows authentication will be allowed, but only using the NTLM protocol.\nNone - Windows authentication will not be allowed.",
"title": "UseWindowsAuth",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "UseWindowsAuth"
},
"DefaultValidityPeriodHours": {
"__type_requested": "uint64",
"required": false,
"description": "When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period.\nDefaultValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). The default value is 4320 (180 days).",
"title": "DefaultValidityPeriodHours",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "DefaultValidityPeriodHours"
},
"AllowAnonymousAccessToLWAConference": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True (the default value), anonymous users will be allowed to attend Skype for Business web App conferences.",
"title": "AllowAnonymousAccessToLWAConference",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AllowAnonymousAccessToLWAConference"
},
"UseDomainAuthInLWA": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users.",
"title": "UseDomainAuthInLWA",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "UseDomainAuthInLWA"
},
"MaxValidityPeriodHours": {
"__type_requested": "uint64",
"required": false,
"description": "When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. MaxValidityPeriodHours represents the maximum amount of time a client can request.\nMaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). The default value is 8760.",
"title": "MaxValidityPeriodHours",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MaxValidityPeriodHours"
},
"MaxGroupSizeToExpand": {
"__type_requested": "UInt32",
"required": false,
"description": "Represents the maximum number of people that will be displayed when a group is expanded. For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded.\nMaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. The default value is 100.",
"title": "MaxGroupSizeToExpand",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxGroupSizeToExpand"
},
"UseWsFedPassiveAuth": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. The default value is False ($False).",
"title": "UseWsFedPassiveAuth",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "UseWsFedPassiveAuth"
}
},
"schema_version": "1150"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/add/ |
|
The GUI Add form of device/skypeforbusiness/CsWebServiceConfiguration 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/CsWebServiceConfiguration/ | 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/CsWebServiceConfiguration/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsWebServiceConfiguration/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/skypeforbusiness/CsWebServiceConfiguration/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsWebServiceConfiguration/[pkid1]", "/api/v0/device/skypeforbusiness/CsWebServiceConfiguration/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsWebServiceConfiguration/?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/CsWebServiceConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsWebServiceConfiguration |
|
{"hrefs": ["/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsWebServiceConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsWebServiceConfiguration/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid1]", "/api/device/skypeforbusiness/CsWebServiceConfiguration/[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/CsWebServiceConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsWebServiceConfiguration.
GET http://[host-proxy]/api/device/skypeforbusiness/CsWebServiceConfiguration/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsWebServiceConfiguration | POST | /api/device/skypeforbusiness/CsWebServiceConfiguration/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/CsWebServiceConfiguration/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/CsWebServiceConfiguration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/ |
|
The device/skypeforbusiness/CsWebServiceConfiguration schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsWebServiceConfiguration instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/skypeforbusiness/CsWebServiceConfiguration/?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/CsWebServiceConfiguration/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/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/CsWebServiceConfiguration",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/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/CsWebServiceConfiguration/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/skypeforbusiness/CsWebServiceConfiguration/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/skypeforbusiness/CsWebServiceConfiguration",
"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": "20.1.1",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/skypeforbusiness/CsWebServiceConfiguration. | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsWebServiceConfiguration as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/skypeforbusiness/CsWebServiceConfiguration/[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/CsWebServiceConfiguration/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsWebServiceConfiguration/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsWebServiceConfiguration | 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/CsWebServiceConfiguration; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/[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/CsWebServiceConfiguration and the JSON format can be used to import instances of device/skypeforbusiness/CsWebServiceConfiguration.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsWebServiceConfiguration instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsWebServiceConfiguration. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/skypeforbusiness/CsWebServiceConfiguration/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |