[Index]
Model ref.: device/skypeforbusinesshybrid/CsService
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": { "AppSharingPortStart": { "__type_requested": "uint16", "required": false, "name": "AppSharingPortStart", "title": "AppSharingPortStart", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AudioPortCount": { "__type_requested": "uint16", "required": false, "name": "AudioPortCount", "title": "AudioPortCount", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AppSharingPortCount": { "__type_requested": "uint16", "required": false, "name": "AppSharingPortCount", "title": "AppSharingPortCount", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AudioPortStart": { "__type_requested": "uint16", "required": false, "name": "AudioPortStart", "title": "AudioPortStart", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RequiresReplication": { "__type_requested": "bool", "required": false, "name": "RequiresReplication", "title": "RequiresReplication", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "VideoPortCount": { "__type_requested": "uint16", "required": false, "name": "VideoPortCount", "title": "VideoPortCount", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Applications": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "Applications", "title": "Applications", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "TreatAsAuthenticated": { "__type_requested": "bool", "required": false, "name": "TreatAsAuthenticated", "title": "TreatAsAuthenticated", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "Version": { "__type_requested": "uint32", "required": false, "name": "Version", "title": "Version", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "Role": { "__type_requested": "string", "required": false, "name": "Role", "title": "Role", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DependentServiceList": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "DependentServiceList", "title": "DependentServiceList", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "OutboundOnly": { "__type_requested": "bool", "required": false, "name": "OutboundOnly", "title": "OutboundOnly", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ServiceId": { "__type_requested": "string", "required": false, "name": "ServiceId", "title": "ServiceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "VideoPortStart": { "__type_requested": "uint16", "required": false, "name": "VideoPortStart", "title": "VideoPortStart", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "FileStore": { "__type_requested": "string", "required": false, "name": "FileStore", "title": "FileStore", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the File Stores used in your organization. The File Store is used to maintain Skype for Business Server 2015 files, such as audio files used by the Announcement service." }, "PoolFqdn": { "__type_requested": "string", "required": false, "name": "PoolFqdn", "title": "PoolFqdn", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Fully qualified domain name (FQDN) of the pool hosting the service or server role. If you use the PoolFqdn parameter without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned." }, "Registrar": { "__type_requested": "string", "required": false, "name": "Registrar", "title": "Registrar", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Registrars used in your organization. Registrars are used to authenticate users and to keep track of a user's current status." }, "SiteId": { "__type_requested": "string", "required": false, "name": "SiteId", "title": "SiteId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Unique identifier of the specific service or server role to be returned. For example:\n-Identity \"Registrar:atl-cs-001.litwareinc.com\"" }, "ThrottleAsServer": { "__type_requested": "bool", "required": false, "name": "ThrottleAsServer", "title": "ThrottleAsServer", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsService/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsService/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsService/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsService/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsService/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsService |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsService/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsService |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsService/[pkid1]", "/api/device/skypeforbusinesshybrid/CsService/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsService/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsService/[pkid1]", "/api/device/skypeforbusinesshybrid/CsService/[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/CsService and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsService.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsService/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsService | POST | /api/device/skypeforbusinesshybrid/CsService/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/skypeforbusinesshybrid/CsService/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/skypeforbusinesshybrid/CsService/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusinesshybrid/CsService/ |
|
The device/skypeforbusinesshybrid/CsService schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsService instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": null, "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusinesshybrid/CsService/?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": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/skypeforbusinesshybrid/CsService/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/CsService", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusinesshybrid/CsService/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/CsService/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusinesshybrid/CsService/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusinesshybrid/CsService/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusinesshybrid/CsService/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusinesshybrid/CsService/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusinesshybrid/CsService/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusinesshybrid/CsService", "model_specific_actions": [ "get", "list", "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/skypeforbusinesshybrid/CsService. | GET | /api/device/skypeforbusinesshybrid/CsService/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsService as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsService/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsService/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsService | 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/CsService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsService/[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/skypeforbusinesshybrid/CsService and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsService.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusinesshybrid/CsService/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsService instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusinesshybrid/CsService/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsService. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusinesshybrid/CsService/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |