[Index]
Model ref.: device/skypeforbusiness/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": { "ApplicationDatabase": { "__type_requested": "string", "required": false, "name": "ApplicationDatabase", "title": "ApplicationDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Application databases used in your organization. Application databases are used by the Application service." }, "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" }, "IsDfsShare": { "__type_requested": "bool", "required": false, "name": "IsDfsShare", "title": "IsDfsShare", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "InternalFqdn": { "__type_requested": "Microsoft.Rtc.Management.Deploy.Fqdn", "required": true, "name": "InternalFqdn", "title": "InternalFqdn", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AutodiscoverServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "AutodiscoverServiceInternalUri", "title": "AutodiscoverServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExternalHttpPort": { "__type_requested": "uint16", "required": false, "name": "ExternalHttpPort", "title": "ExternalHttpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MeetingRoomAdminPortalExternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "MeetingRoomAdminPortalExternalListeningPort", "title": "MeetingRoomAdminPortalExternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BackupPersistentChatDatabase": { "__type_requested": "string", "required": false, "name": "BackupPersistentChatDatabase", "title": "BackupPersistentChatDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "UcwaSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "UcwaSipPrimaryListeningPort", "title": "UcwaSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AppSharingSipPort": { "__type_requested": "uint16", "required": false, "name": "AppSharingSipPort", "title": "AppSharingSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BackupRegistrar": { "__type_requested": "string", "required": false, "name": "BackupRegistrar", "title": "BackupRegistrar", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ConfDirManagementWcfTcpPort": { "__type_requested": "uint16", "required": false, "name": "ConfDirManagementWcfTcpPort", "title": "ConfDirManagementWcfTcpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ArchivingDatabase": { "__type_requested": "string", "required": false, "name": "ArchivingDatabase", "title": "ArchivingDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Archiving databases used in your organization. Archiving databases store transcripts of instant messaging sessions." }, "PrimaryUcapSipPort": { "__type_requested": "uint16", "required": false, "name": "PrimaryUcapSipPort", "title": "PrimaryUcapSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BRBStorageServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "BRBStorageServiceInternalUri", "title": "BRBStorageServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CentralManagementDatabase": { "__type_requested": "string", "required": false, "name": "CentralManagementDatabase", "title": "CentralManagementDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Central Management store used in your organization. The Central Management store maintains configuration information for Skype for Business Server 2015." }, "ReachPrimaryPsomServerPort": { "__type_requested": "uint16", "required": false, "name": "ReachPrimaryPsomServerPort", "title": "ReachPrimaryPsomServerPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MirrorUserDatabase": { "__type_requested": "string", "required": false, "name": "MirrorUserDatabase", "title": "MirrorUserDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AudioVideoSipPort": { "__type_requested": "uint16", "required": false, "name": "AudioVideoSipPort", "title": "AudioVideoSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PhoneWebPort": { "__type_requested": "uint16", "required": false, "name": "PhoneWebPort", "title": "PhoneWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AppSharingWebPort": { "__type_requested": "uint16", "required": false, "name": "AppSharingWebPort", "title": "AppSharingWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WinFabReplicationPort": { "__type_requested": "uint16", "required": false, "name": "WinFabReplicationPort", "title": "WinFabReplicationPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MeetingWebPort": { "__type_requested": "uint16", "required": false, "name": "MeetingWebPort", "title": "MeetingWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SipClientTcpPort": { "__type_requested": "uint16", "required": false, "name": "SipClientTcpPort", "title": "SipClientTcpPort", "__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" }, "SupportConferenceConsoleSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "SupportConferenceConsoleSipPrimaryListeningPort", "title": "SupportConferenceConsoleSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SipHealthPort": { "__type_requested": "uint16", "required": false, "name": "SipHealthPort", "title": "SipHealthPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ServiceId": { "__type_requested": "string", "required": false, "name": "ServiceId", "title": "ServiceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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." }, "EdgeServer": { "__type_requested": "string", "required": false, "name": "EdgeServer", "title": "EdgeServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Edge Servers used in your organization. Edge Servers provide connectivity between your internal network and the Internet." }, "HybridConfigServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "HybridConfigServiceInternalUri", "title": "HybridConfigServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ImSipPort": { "__type_requested": "uint16", "required": false, "name": "ImSipPort", "title": "ImSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PdpSipPort": { "__type_requested": "uint16", "required": false, "name": "PdpSipPort", "title": "PdpSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WebPort": { "__type_requested": "uint16", "required": false, "name": "WebPort", "title": "WebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DialinExternalUri": { "__type_requested": "uri", "required": false, "name": "DialinExternalUri", "title": "DialinExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BackupMirrorPersistentChatDatabase": { "__type_requested": "string", "required": false, "name": "BackupMirrorPersistentChatDatabase", "title": "BackupMirrorPersistentChatDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "FailureDetectionInterval": { "__type_requested": "timespan", "required": false, "name": "FailureDetectionInterval", "title": "FailureDetectionInterval", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PrimaryHttpPort": { "__type_requested": "uint16", "required": false, "name": "PrimaryHttpPort", "title": "PrimaryHttpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MonitoringServer": { "__type_requested": "string", "required": false, "name": "MonitoringServer", "title": "MonitoringServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Monitoring Servers used in your organization. Monitoring Servers are used to track Enterprise Voice phone usage and call quality." }, "RgsAgentServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "RgsAgentServiceExternalUri", "title": "RgsAgentServiceExternalUri", "__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" }, "DisplayName": { "__type_requested": "string", "required": true, "name": "DisplayName", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RmWebSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "RmWebSipPrimaryListeningPort", "title": "RmWebSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Version": { "__type_requested": "uint32", "required": false, "name": "Version", "title": "Version", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "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." }, "UcwaServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "UcwaServiceExternalUri", "title": "UcwaServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ABHandlerInternalUri": { "__type_requested": "uri", "required": false, "name": "ABHandlerInternalUri", "title": "ABHandlerInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CpsSipPort": { "__type_requested": "uint16", "required": false, "name": "CpsSipPort", "title": "CpsSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PersistentChatWebInternalUri": { "__type_requested": "uri", "required": false, "name": "PersistentChatWebInternalUri", "title": "PersistentChatWebInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MirrorPersistentChatDatabase": { "__type_requested": "string", "required": false, "name": "MirrorPersistentChatDatabase", "title": "MirrorPersistentChatDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "McxSipExternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "McxSipExternalListeningPort", "title": "McxSipExternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MediaOnlyConferenceServer": { "__type_requested": "string", "required": false, "name": "MediaOnlyConferenceServer", "title": "MediaOnlyConferenceServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CasSipPort": { "__type_requested": "uint16", "required": false, "name": "CasSipPort", "title": "CasSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MeetExternalUri": { "__type_requested": "uri", "required": false, "name": "MeetExternalUri", "title": "MeetExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UcwaServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "UcwaServiceInternalUri", "title": "UcwaServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "VxmlServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "VxmlServiceInternalUri", "title": "VxmlServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "HostedMigrationServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "HostedMigrationServiceExternalUri", "title": "HostedMigrationServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PhoneSipPort": { "__type_requested": "uint16", "required": false, "name": "PhoneSipPort", "title": "PhoneSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CAHandlerInternalAnonUri": { "__type_requested": "uri", "required": false, "name": "CAHandlerInternalAnonUri", "title": "CAHandlerInternalAnonUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ActiveServers": { "__type_requested": "System.Collections.Generic.IList[string]", "required": true, "name": "ActiveServers", "title": "ActiveServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "PrimaryUcwaSipPort": { "__type_requested": "uint16", "required": false, "name": "PrimaryUcwaSipPort", "title": "PrimaryUcwaSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SipClientTlsPort": { "__type_requested": "uint16", "required": false, "name": "SipClientTlsPort", "title": "SipClientTlsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AudioVideoWebPort": { "__type_requested": "uint16", "required": false, "name": "AudioVideoWebPort", "title": "AudioVideoWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UserServer": { "__type_requested": "string", "required": false, "name": "UserServer", "title": "UserServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the User Services service used in your organization. The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange." }, "MonitoringDatabase": { "__type_requested": "string", "required": false, "name": "MonitoringDatabase", "title": "MonitoringDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the monitoring databases used in your organization. Monitoring databases store Enterprise Voice phone usage and call quality information." }, "LIServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "LIServiceInternalUri", "title": "LIServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RgsSipPort": { "__type_requested": "uint16", "required": false, "name": "RgsSipPort", "title": "RgsSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DataPsomPort": { "__type_requested": "uint16", "required": false, "name": "DataPsomPort", "title": "DataPsomPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MirrorArchivingDatabase": { "__type_requested": "string", "required": false, "name": "MirrorArchivingDatabase", "title": "MirrorArchivingDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DeviceUpdateDownloadExternalUri": { "__type_requested": "uri", "required": false, "name": "DeviceUpdateDownloadExternalUri", "title": "DeviceUpdateDownloadExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MirrorApplicationDatabase": { "__type_requested": "string", "required": false, "name": "MirrorApplicationDatabase", "title": "MirrorApplicationDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DeviceUpdateStoreExternalUri": { "__type_requested": "uri", "required": false, "name": "DeviceUpdateStoreExternalUri", "title": "DeviceUpdateStoreExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RgsWcfMtlsPort": { "__type_requested": "uint16", "required": false, "name": "RgsWcfMtlsPort", "title": "RgsWcfMtlsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WebServer": { "__type_requested": "string", "required": false, "name": "WebServer", "title": "WebServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Web Services service used in your organization. The Web Services service host web-based applications such as the Address Book service." }, "SqlInstanceName": { "__type_requested": "string", "required": false, "name": "SqlInstanceName", "title": "SqlInstanceName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MirrorPersistentChatComplianceDatabase": { "__type_requested": "string", "required": false, "name": "MirrorPersistentChatComplianceDatabase", "title": "MirrorPersistentChatComplianceDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PublishedPrimaryHttpPort": { "__type_requested": "uint16", "required": false, "name": "PublishedPrimaryHttpPort", "title": "PublishedPrimaryHttpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PersistentChatComplianceDatabase": { "__type_requested": "string", "required": false, "name": "PersistentChatComplianceDatabase", "title": "PersistentChatComplianceDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the databases used for maintaining Persistent Chat compliance information." }, "ReachInternalUri": { "__type_requested": "uri", "required": false, "name": "ReachInternalUri", "title": "ReachInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InactiveServers": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "InactiveServers", "title": "InactiveServers", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "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" }, "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" }, "SipServerTcpPort": { "__type_requested": "uint16", "required": false, "name": "SipServerTcpPort", "title": "SipServerTcpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UcwaSipExternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "UcwaSipExternalListeningPort", "title": "UcwaSipExternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MeetingPsomPort": { "__type_requested": "uint16", "required": false, "name": "MeetingPsomPort", "title": "MeetingPsomPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RmWebSipExternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "RmWebSipExternalListeningPort", "title": "RmWebSipExternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DataWebPort": { "__type_requested": "uint16", "required": false, "name": "DataWebPort", "title": "DataWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ShareName": { "__type_requested": "string", "required": false, "name": "ShareName", "title": "ShareName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AutodiscoverServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "AutodiscoverServiceExternalUri", "title": "AutodiscoverServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SupportConferenceConsoleSipExternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "SupportConferenceConsoleSipExternalListeningPort", "title": "SupportConferenceConsoleSipExternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SipServerPort": { "__type_requested": "uint16", "required": false, "name": "SipServerPort", "title": "SipServerPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WinFabFederationPort": { "__type_requested": "uint16", "required": false, "name": "WinFabFederationPort", "title": "WinFabFederationPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UserPinManagementWcfHttpPort": { "__type_requested": "uint16", "required": false, "name": "UserPinManagementWcfHttpPort", "title": "UserPinManagementWcfHttpPort", "__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" }, "LyssWcfMtlsPort": { "__type_requested": "uint16", "required": false, "name": "LyssWcfMtlsPort", "title": "LyssWcfMtlsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Active": { "__type_requested": "bool", "required": false, "name": "Active", "title": "Active", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ReachExternalPsomServerPort": { "__type_requested": "uint16", "required": false, "name": "ReachExternalPsomServerPort", "title": "ReachExternalPsomServerPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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\"" }, "XmppGatewaySipPort": { "__type_requested": "uint16", "required": false, "name": "XmppGatewaySipPort", "title": "XmppGatewaySipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WacServer": { "__type_requested": "string", "required": false, "name": "WacServer", "title": "WacServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Office Web Apps servers used with Microsoft Lync Server. Office Web Apps server was previously known as \"WacServer\"." }, "PersistentChatWebManagerExternalUri": { "__type_requested": "uri", "required": false, "name": "PersistentChatWebManagerExternalUri", "title": "PersistentChatWebManagerExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "McuFactorySipPort": { "__type_requested": "uint16", "required": false, "name": "McuFactorySipPort", "title": "McuFactorySipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "FailbackDetectionInterval": { "__type_requested": "timespan", "required": false, "name": "FailbackDetectionInterval", "title": "FailbackDetectionInterval", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CscpInternalUri": { "__type_requested": "uri", "required": false, "name": "CscpInternalUri", "title": "CscpInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PublishedPrimaryHttpsPort": { "__type_requested": "uint16", "required": false, "name": "PublishedPrimaryHttpsPort", "title": "PublishedPrimaryHttpsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BRBStorageServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "BRBStorageServiceExternalUri", "title": "BRBStorageServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RgsAgentServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "RgsAgentServiceInternalUri", "title": "RgsAgentServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BackupMirrorPersistentChatComplianceDatabase": { "__type_requested": "string", "required": false, "name": "BackupMirrorPersistentChatComplianceDatabase", "title": "BackupMirrorPersistentChatComplianceDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ExternalUcwaSipPort": { "__type_requested": "uint16", "required": false, "name": "ExternalUcwaSipPort", "title": "ExternalUcwaSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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" }, "ReachExternalUri": { "__type_requested": "uri", "required": false, "name": "ReachExternalUri", "title": "ReachExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExternalHttpsPort": { "__type_requested": "uint16", "required": false, "name": "ExternalHttpsPort", "title": "ExternalHttpsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PublishedExternalHttpsPort": { "__type_requested": "uint16", "required": false, "name": "PublishedExternalHttpsPort", "title": "PublishedExternalHttpsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DeviceUpdateStoreInternalUri": { "__type_requested": "uri", "required": false, "name": "DeviceUpdateStoreInternalUri", "title": "DeviceUpdateStoreInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "McxSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "McxSipPrimaryListeningPort", "title": "McxSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PrimaryVxmlSipPort": { "__type_requested": "uint16", "required": false, "name": "PrimaryVxmlSipPort", "title": "PrimaryVxmlSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CollabContentExternalUri": { "__type_requested": "uri", "required": false, "name": "CollabContentExternalUri", "title": "CollabContentExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SupportConferenceConsoleExternalUri": { "__type_requested": "uri", "required": false, "name": "SupportConferenceConsoleExternalUri", "title": "SupportConferenceConsoleExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SupportConferenceConsoleInternalUri": { "__type_requested": "uri", "required": false, "name": "SupportConferenceConsoleInternalUri", "title": "SupportConferenceConsoleInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MtlsPort": { "__type_requested": "uint16", "required": false, "name": "MtlsPort", "title": "MtlsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SipPort": { "__type_requested": "uint16", "required": false, "name": "SipPort", "title": "SipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WebTicketExternalUri": { "__type_requested": "uri", "required": false, "name": "WebTicketExternalUri", "title": "WebTicketExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "VxmlSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "VxmlSipPrimaryListeningPort", "title": "VxmlSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WinFabLeaseAgentPort": { "__type_requested": "uint16", "required": false, "name": "WinFabLeaseAgentPort", "title": "WinFabLeaseAgentPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UcapServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "UcapServiceExternalUri", "title": "UcapServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PrimaryHttpsPort": { "__type_requested": "uint16", "required": false, "name": "PrimaryHttpsPort", "title": "PrimaryHttpsPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WinFabIPCPort": { "__type_requested": "uint16", "required": false, "name": "WinFabIPCPort", "title": "WinFabIPCPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "VxmlServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "VxmlServiceExternalUri", "title": "VxmlServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CaaSipPort": { "__type_requested": "uint16", "required": false, "name": "CaaSipPort", "title": "CaaSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MirrorCentralManagementDatabase": { "__type_requested": "string", "required": false, "name": "MirrorCentralManagementDatabase", "title": "MirrorCentralManagementDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Mcus": { "__type_requested": "System.Collections.Generic.IList[string]", "required": false, "name": "Mcus", "title": "Mcus", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": true, "type": "array" }, "UcapSipPrimaryListeningPort": { "__type_requested": "uint16", "required": false, "name": "UcapSipPrimaryListeningPort", "title": "UcapSipPrimaryListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "EnableAutomaticFailover": { "__type_requested": "bool", "required": true, "name": "EnableAutomaticFailover", "title": "EnableAutomaticFailover", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "MirrorMonitoringDatabase": { "__type_requested": "string", "required": false, "name": "MirrorMonitoringDatabase", "title": "MirrorMonitoringDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "UncPath": { "__type_requested": "string", "required": false, "name": "UncPath", "title": "UncPath", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "PdpTurnPort": { "__type_requested": "uint16", "required": false, "name": "PdpTurnPort", "title": "PdpTurnPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MeetingRoomAdminPortalInternalListeningPort": { "__type_requested": "uint16", "required": false, "name": "MeetingRoomAdminPortalInternalListeningPort", "title": "MeetingRoomAdminPortalInternalListeningPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PublishedExternalHttpPort": { "__type_requested": "uint16", "required": false, "name": "PublishedExternalHttpPort", "title": "PublishedExternalHttpPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ConferenceServer": { "__type_requested": "string", "required": false, "name": "ConferenceServer", "title": "ConferenceServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "HybridConfigServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "HybridConfigServiceExternalUri", "title": "HybridConfigServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CollabContentInternalUri": { "__type_requested": "uri", "required": false, "name": "CollabContentInternalUri", "title": "CollabContentInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AtsSipPort": { "__type_requested": "uint16", "required": false, "name": "AtsSipPort", "title": "AtsSipPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Role": { "__type_requested": "string", "required": false, "name": "Role", "title": "Role", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DeviceUpdateDownloadInternalUri": { "__type_requested": "uri", "required": false, "name": "DeviceUpdateDownloadInternalUri", "title": "DeviceUpdateDownloadInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ArchivingServer": { "__type_requested": "string", "required": false, "name": "ArchivingServer", "title": "ArchivingServer", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the Archiving Servers used in your organization. Archiving Servers enable you to save the transcripts of instant messaging sessions." }, "BackupPersistentChatComplianceDatabase": { "__type_requested": "string", "required": false, "name": "BackupPersistentChatComplianceDatabase", "title": "BackupPersistentChatComplianceDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "CAHandlerExternalUri": { "__type_requested": "uri", "required": false, "name": "CAHandlerExternalUri", "title": "CAHandlerExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UserDatabase": { "__type_requested": "string", "required": false, "name": "UserDatabase", "title": "UserDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the User database used in your organization. User databases store data needed by the User Server service." }, "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." }, "WinFabClientConnectionPort": { "__type_requested": "uint16", "required": false, "name": "WinFabClientConnectionPort", "title": "WinFabClientConnectionPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DLExpansionInternalUri": { "__type_requested": "uri", "required": false, "name": "DLExpansionInternalUri", "title": "DLExpansionInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WebTicketInternalUri": { "__type_requested": "uri", "required": false, "name": "WebTicketInternalUri", "title": "WebTicketInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly 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" }, "ABHandlerExternalUri": { "__type_requested": "uri", "required": false, "name": "ABHandlerExternalUri", "title": "ABHandlerExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ExternalFqdn": { "__type_requested": "Microsoft.Rtc.Management.Deploy.Fqdn", "required": false, "name": "ExternalFqdn", "title": "ExternalFqdn", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ImWebPort": { "__type_requested": "uint16", "required": false, "name": "ImWebPort", "title": "ImWebPort", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PersistentChatDatabase": { "__type_requested": "string", "required": false, "name": "PersistentChatDatabase", "title": "PersistentChatDatabase", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "Returns information about the databases used for maintaining Persistent Chat information." }, "PersistentChatWebManagerInternalUri": { "__type_requested": "uri", "required": false, "name": "PersistentChatWebManagerInternalUri", "title": "PersistentChatWebManagerInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "McxServiceExternalUri": { "__type_requested": "uri", "required": false, "name": "McxServiceExternalUri", "title": "McxServiceExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DLExpansionExternalUri": { "__type_requested": "uri", "required": false, "name": "DLExpansionExternalUri", "title": "DLExpansionExternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CAHandlerInternalUri": { "__type_requested": "uri", "required": false, "name": "CAHandlerInternalUri", "title": "CAHandlerInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SiteId": { "__type_requested": "string", "required": false, "name": "SiteId", "title": "SiteId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "UcapServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "UcapServiceInternalUri", "title": "UcapServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "McxServiceInternalUri": { "__type_requested": "uri", "required": false, "name": "McxServiceInternalUri", "title": "McxServiceInternalUri", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" } }, "schema_version": "1150" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/skypeforbusiness/CsService/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/skypeforbusiness/CsService/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusiness/CsService/[pkid1]", "/api/v0/device/skypeforbusiness/CsService/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusiness/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/skypeforbusiness/CsService |
|
{"hrefs": ["/api/device/skypeforbusiness/CsService/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusiness/CsService |
|
{"hrefs": ["/api/device/skypeforbusiness/CsService/[pkid1]", "/api/device/skypeforbusiness/CsService/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusiness/CsService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusiness/CsService/export/ |
|
{ "hrefs":["/api/device/skypeforbusiness/CsService/[pkid1]", "/api/device/skypeforbusiness/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/skypeforbusiness/CsService and the JSON format can be used to import instances of device/skypeforbusiness/CsService.
GET http://[host-proxy]/api/device/skypeforbusiness/CsService/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusiness/CsService | POST | /api/device/skypeforbusiness/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/skypeforbusiness/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/skypeforbusiness/CsService/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/skypeforbusiness/CsService/ |
|
The device/skypeforbusiness/CsService schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusiness/CsService instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/skypeforbusiness/CsService/?skip=0&limit=3&order_by=DisplayName&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/skypeforbusiness/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/skypeforbusiness/CsService", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/skypeforbusiness/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/skypeforbusiness/CsService/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/skypeforbusiness/CsService/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/skypeforbusiness/CsService/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/skypeforbusiness/CsService/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/skypeforbusiness/CsService/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/skypeforbusiness/CsService/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/skypeforbusiness/CsService", "model_specific_actions": [ "get", "list", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "DisplayName" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/skypeforbusiness/CsService. | GET | /api/device/skypeforbusiness/CsService/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusiness/CsService as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusiness/CsService/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusiness/CsService/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusiness/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/skypeforbusiness/CsService; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusiness/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/skypeforbusiness/CsService and the JSON format can be used to import instances of device/skypeforbusiness/CsService.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/skypeforbusiness/CsService/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusiness/CsService instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/skypeforbusiness/CsService/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusiness/CsService. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/skypeforbusiness/CsService/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |