[Index]
Model ref.: device/skypeforbusiness/CsHostingProvider
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": { "AutodiscoverUrl": { "__type_requested": "String", "required": false, "description": "URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server 2015 accounts. The autodiscover service enables client applications to determine how to access resources such as a user's home pool.", "title": "AutodiscoverUrl", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "AutodiscoverUrl" }, "EnabledSharedAddressSpace": { "__type_requested": "$true | $false", "required": true, "description": "If True, indicates that the hosting provider is being used in a split domain scenario. The default value is False.", "title": "EnabledSharedAddressSpace", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "EnabledSharedAddressSpace" }, "SipClientPort": { "__type_requested": "uint64", "required": false, "description": "Port used by the provider for communicating with SIP clients; the default value is 443. Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet. To see the SipClientPort, use a command similar to this:\nGet-CsHostingProvider | Select-Object *", "title": "SipClientPort", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "SipClientPort" }, "IsLocal": { "__type_requested": "$true | $false", "required": false, "description": "If True, indicates that the proxy server used by the hosting provider is contained within your Skype for Business Server 2015 topology. The default value is False.", "title": "IsLocal", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsLocal" }, "HostsOCSUsers": { "__type_requested": "$true | $false", "required": true, "description": "If True, indicates that the hosting provider is used to host Skype for Business Server 2015 accounts. If False, that indicates that the provider hosts other account types, such as Microsoft Exchange accounts. The default value is False.", "title": "HostsOCSUsers", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "HostsOCSUsers" }, "Enabled": { "__type_requested": "$true | $false", "required": true, "description": "Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. The default value is False.", "title": "Enabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Enabled" }, "ProxyFqdn": { "__type_requested": "String", "required": true, "description": "The FQDN for the proxy server used by the hosting provider. Note that this value cannot be modified. If the hosting provider later changes its proxy server or if you make a mistake when you first specify the proxy FQDN you will need to delete and then recreate the entry for that provider.", "title": "ProxyFqdn", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "ProxyFqdn" }, "VerificationLevel": { "__type_requested": "Microsoft.Rtc.Management.WritableConfig.Settings.Edge.VerificationLevelType", "required": false, "description": "Indicates the allowed verification level for messages sent to and from the hosted provider. The VerificationLevel must be set to one of the following values:\nAlwaysVerifiable. Indicates that all messages sent from the hosting provider are considered verifiable. That means that no messages from the hosting provider will be rejected.\nAlwaysUnverifiable. Indicates that all messages sent from the hosting provider are considered unverifiable. As a result, messages are passed only if the user on the hosting provider is also in your Contacts list.\nUseSourceVerification. Relies on the verification level included in messages sent from the hosting provider. If this level is not specified, then the message will be rejected as being unverifiable.\nThe default value is AlwayVerifiable.", "title": "VerificationLevel", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "VerificationLevel" }, "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" }, "Identity": { "__type_requested": "string", "required": true, "description": "Unique identifier for the hosting provider to be created. The Identity is a string value; the Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.).\nHosting provider Identities must be unique. Your command will fail if you try to create a new hosting provider with the same Identity as an existing provider.", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Identity" }, "Name": { "__type_requested": "string", "required": false, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": true, "type": "string" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/skypeforbusiness/CsHostingProvider/add/ |
|
The GUI Add form of device/skypeforbusiness/CsHostingProvider 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/CsHostingProvider/ | 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/CsHostingProvider/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/skypeforbusiness/CsHostingProvider/[pkid1]", "/api/device/skypeforbusiness/CsHostingProvider/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsHostingProvider/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsHostingProvider/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsHostingProvider/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsHostingProvider/[pkid1]", "/api/v0/device/skypeforbusiness/CsHostingProvider/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/CsHostingProvider/?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/CsHostingProvider |
|
{"hrefs": ["/api/device/skypeforbusiness/CsHostingProvider/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsHostingProvider |
|
{"hrefs": ["/api/device/skypeforbusiness/CsHostingProvider/[pkid1]", "/api/device/skypeforbusiness/CsHostingProvider/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsHostingProvider; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsHostingProvider/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsHostingProvider/[pkid1]", "/api/device/skypeforbusiness/CsHostingProvider/[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/CsHostingProvider and the JSON format can be used to import instances of device/skypeforbusiness/CsHostingProvider.
GET http://[host-proxy]/api/device/skypeforbusiness/CsHostingProvider/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsHostingProvider | POST | /api/device/skypeforbusiness/CsHostingProvider/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/CsHostingProvider/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/CsHostingProvider/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsHostingProvider/ |
|
The device/skypeforbusiness/CsHostingProvider schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsHostingProvider instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsHostingProvider/?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/CsHostingProvider/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/skypeforbusiness/CsHostingProvider/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusiness/CsHostingProvider/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/CsHostingProvider", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/CsHostingProvider/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/CsHostingProvider/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsHostingProvider/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsHostingProvider/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsHostingProvider/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsHostingProvider/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsHostingProvider/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsHostingProvider", "model_specific_actions": [ "powershell_disable", "powershell_enable", "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/CsHostingProvider. | GET | /api/device/skypeforbusiness/CsHostingProvider/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsHostingProvider as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/skypeforbusiness/CsHostingProvider/[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/CsHostingProvider/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsHostingProvider/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/CsHostingProvider | 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/CsHostingProvider; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/CsHostingProvider/[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/CsHostingProvider and the JSON format can be used to import instances of device/skypeforbusiness/CsHostingProvider.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsHostingProvider instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsHostingProvider. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Disable | POST | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Powershell Enable | POST | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsHostingProvider/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |