[Index]
Model ref.: device/skypeforbusinesshybrid/CsClientPolicy
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": {
"DGRefreshInterval": {
"__type_requested": "System.Nullable[timespan]",
"required": false,
"description": "Indicates the amount of time Skype for Business waits before automatically refreshing the membership list of any distribution group that has been \"expanded\" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds.",
"title": "DGRefreshInterval",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "DGRefreshInterval"
},
"TracingLevel": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Client.TracingLevel",
"required": false,
"description": "Enables Administrators to manage event tracing and logging in Skype for Business. Allowed values are:\nOff - Tracing is disabled and the user cannot change this setting.\nLight - Minimal tracing is performed, and the user cannot change this setting.\nFull - Verbose tracing is performed, and the user cannot change this setting.\nBy default TracingLevel is set to Light.",
"title": "TracingLevel",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "TracingLevel"
},
"ConferenceIMIdleTimeoutExtended": {
"__type_requested": "timespan",
"required": false,
"name": "ConferenceIMIdleTimeoutExtended",
"title": "ConferenceIMIdleTimeoutExtended",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"MaximumNumberOfContacts": {
"__type_requested": "System.Nullable[uint16]",
"required": false,
"description": "Indicates the maximum number of contacts a user is allowed to have. The maximum contacts can be set to any integer value between 0 and 1000, inclusive. When set to 0, that prevents the user from having any contacts.",
"title": "MaximumNumberOfContacts",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MaximumNumberOfContacts"
},
"DisablePoorDeviceWarnings": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, Skype for Business will not issue warnings (for example, upon startup, in the Tuning Wizard, and in the Conversation window) if an audio or video device is not working correctly. When set to False, these warnings will be issued.",
"title": "DisablePoorDeviceWarnings",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisablePoorDeviceWarnings"
},
"AddressBookAvailability": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Client.AddressBookAvailability",
"required": false,
"description": "Indicates how users are allowed to access information by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values:\nWebSearchAndFileDownload\nWebSearchOnly\nFileDownloadOnly",
"title": "AddressBookAvailability",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "AddressBookAvailability"
},
"IMLatencySpinnerDelay": {
"__type_requested": "UInt32",
"required": false,
"description": "Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed.",
"title": "IMLatencySpinnerDelay",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "IMLatencySpinnerDelay"
},
"AutoDiscoveryRetryInterval": {
"__type_requested": "System.Nullable[timespan]",
"required": false,
"description": "After a failed connection attempt, specifies the amount of time Skype for Business waits before trying again to connect to Skype for Business Server 2015. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive.\nWhen specifying the AutoDiscoveryRetryInterval you must use the format hours:minutes:seconds. For example, to set the interval to 25 minutes use this syntax: - AutoDiscoveryRetryInterval 00:25:00",
"title": "AutoDiscoveryRetryInterval",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "AutoDiscoveryRetryInterval"
},
"SPSearchCenterExternalURL": {
"__type_requested": "String",
"required": false,
"description": "External URL for the SharePoint site used for keyword searches (also known as expert searches). This URL will appear at the bottom of any keyword search results that appear in Skype for Business. If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. (SharePoint offers more search options than does Skype for Business.)\nSPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall.",
"title": "SPSearchCenterExternalURL",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SPSearchCenterExternalURL"
},
"DisableOnlineContextualSearch": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Microsoft Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list.\nNote that this setting only applies to users who are not running Microsoft Outlook in cached mode. That's because any searches conducted by those users must take place on Microsoft Exchange Server, and administrators might want to limit the network traffic generated by these searches. If you are running Outlook in cached mode, searches take place on a user's locally-cached copy of his or her Inbox. Cached searches are not affected by this setting.",
"title": "DisableOnlineContextualSearch",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableOnlineContextualSearch"
},
"DisableSavingIM": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, the options for saving an instant messaging session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window.\nNote that setting this value to True removes the menu options that make it easy for users to save instant messaging transcripts. However, it does not prevent users from copying all the text in a transcript to the clipboard, pasting that text into another application, and then saving the transcript that way.",
"title": "DisableSavingIM",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableSavingIM"
},
"EnableExchangeContactSync": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True (the default value) Skype for Business creates a corresponding personal contact in Microsoft Outlook for each person on a user's Skype for Business Contacts list.",
"title": "EnableExchangeContactSync",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableExchangeContactSync"
},
"AttendantSafeTransfer": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, Attendant operates in \"safe transfer\" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a \"Failed Transfer\" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area.",
"title": "AttendantSafeTransfer",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "AttendantSafeTransfer"
},
"IMWarning": {
"__type_requested": "String",
"required": false,
"description": "When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. For example, if IMWarning is set to \"All information is the property of Litwareinc\" then that message will appear in the Conversation window each time a user takes part in an instant messaging session.\nIf set to a null value ($Null), then no message appears in the Conversation window.\nYour warning message should be limited to 256 characters, and can only contain plain text. You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text.",
"title": "IMWarning",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "IMWarning"
},
"PolicyEntry": {
"__type_requested": "System.Collections.Generic.IList[Microsoft.Rtc.Management.WritableConfig.Policy.Client.PolicyEntryType]",
"required": false,
"description": "Provides a way to add settings not covered by the default parameters. For example, when testing pre-release versions of Lync 2010 it was possible to add a Send Feedback option to the user interface. That was done by using code similar to this:\n$x = New-CsClientPolicyEntry -Name \"OnlineFeedbackURL\" -Value \"http://www.litwareinc.com/feedback\"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}\nFor more details and examples, see the New-CsClientPolicyEntry cmdlet help topic.",
"title": "PolicyEntry",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "PolicyEntry"
},
"DisplayPhoto": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Client.DisplayPhoto",
"required": false,
"description": "Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are:\nNoPhoto - Photos are not displayed in Skype for Business.\nPhotosFromADOnly - Only photos that have been published in Active Directory can be displayed.\nAllPhotos - Either Active Directory or custom photos can be displayed.\nThe default value is AllPhotos.",
"title": "DisplayPhoto",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "DisplayPhoto"
},
"PlayAbbreviatedDialTone": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. (A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than \"regular\" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook.",
"title": "PlayAbbreviatedDialTone",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "PlayAbbreviatedDialTone"
},
"DisableHtmlIm": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists, and buttons) will be retained when pasted into an instant message.\nNote that, even when set to False, scripts and other potentially malicious items (such as tags that play a sound) will not be copied into an instant message. You can copy and paste buttons and other controls into a message, but any scripts attached to those controls will automatically be removed.",
"title": "DisableHtmlIm",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableHtmlIm"
},
"DisableEmoticons": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical \"smiley face,\" users will see the text equivalent:\n: )\nWhen set to False, users will be able to include emoticons in their instant messages, and to view emoticons in instant messages they receive.",
"title": "DisableEmoticons",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableEmoticons"
},
"DisablePresenceNote": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, any Out of Office message you configure in Microsoft Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list.",
"title": "DisablePresenceNote",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisablePresenceNote"
},
"EnableHotdesking": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server 2015 account. (Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone by using their own credentials.\nNote that this setting applies only to common area phones and not to users. When set to True and applied to a common area phone, any user will be able to log on to that phone using his or her credentials. When set to False, no users will be allowed to log on to a common area phone where this policy setting has been applied.",
"title": "EnableHotdesking",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableHotdesking"
},
"MusicOnHoldAudioFile": {
"__type_requested": "String",
"required": false,
"description": "Path to the audio file to be played when a caller is placed on hold. If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True.",
"title": "MusicOnHoldAudioFile",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "MusicOnHoldAudioFile"
},
"ShowManagePrivacyRelationships": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, shows the Relationships option in the Skype for Business Contacts list window. When set to False, hides the Relationships option.\nNote that this setting applies only to Lync 2010. Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True.\nThe default value is False.",
"title": "ShowManagePrivacyRelationships",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowManagePrivacyRelationships"
},
"DisablePICPromptDisplayName": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person's SIP address (for example, sip:[email protected]). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) instead.",
"title": "DisablePICPromptDisplayName",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisablePICPromptDisplayName"
},
"EnableCallLogAutoArchiving": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Microsoft Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call; and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook.",
"title": "EnableCallLogAutoArchiving",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableCallLogAutoArchiving"
},
"MaximumDGsAllowedInContactList": {
"__type_requested": "UInt32",
"required": false,
"description": "Indicates the maximum number of distribution groups that a user can configure as a contact. MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. The default value is 10.",
"title": "MaximumDGsAllowedInContactList",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaximumDGsAllowedInContactList"
},
"DisableFeedsTab": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business.",
"title": "DisableFeedsTab",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableFeedsTab"
},
"EnableTracing": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, software tracing will be enabled in Skype for Business; when set to False, software tracing will be disabled. Software tracing involves keeping a detailed record of everything that a program does (including tracking API calls). Tracing is mostly useful to developers and to application support personnel.",
"title": "EnableTracing",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableTracing"
},
"DisableCalendarPresence": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, calendar data taken from Microsoft Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card. Likewise, your status will automatically be set to Busy any time Outlook shows that you are in a meeting.",
"title": "DisableCalendarPresence",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableCalendarPresence"
},
"EnableUnencryptedFileTransfer": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers.",
"title": "EnableUnencryptedFileTransfer",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableUnencryptedFileTransfer"
},
"DisableOneNote12Integration": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, the ability to start Microsoft OneNote from within Skype for Business (and the ability to automatically link instant messaging sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using OneNote is enabled in Skype for Business. In addition, if you locate an instant message transcript in Microsoft Outlook's Conversation History, you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button.",
"title": "DisableOneNote12Integration",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableOneNote12Integration"
},
"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"
},
"CalendarStatePublicationInterval": {
"__type_requested": "UInt32",
"required": false,
"description": "Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from Microsoft Outlook and adding this data to your presence information.\nFor example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax:\n- CalendarStatePublicationInterval 600",
"title": "CalendarStatePublicationInterval",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "CalendarStatePublicationInterval"
},
"DisableContactCardOrganizationTab": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, the contact card Organization tab is not visible within the Skype for Business user interface. When set to False, the contact card Organization tab is available in Skype for Business.",
"title": "DisableContactCardOrganizationTab",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableContactCardOrganizationTab"
},
"Anchor": {
"__type_requested": "Microsoft.Rtc.Management.Core.IScopeAnchor",
"required": false,
"name": "Anchor",
"title": "Anchor",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"CustomLinkInErrorMessages": {
"__type_requested": "String",
"required": false,
"description": "URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, such as troubleshooting tips.",
"title": "CustomLinkInErrorMessages",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "CustomLinkInErrorMessages"
},
"MaxPhotoSizeKB": {
"__type_requested": "UInt32",
"required": false,
"description": "Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business.\nThe default value is 30 kilobytes.",
"title": "MaxPhotoSizeKB",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "MaxPhotoSizeKB"
},
"TabURL": {
"__type_requested": "String",
"required": false,
"description": "Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. This parameter has been deprecated for use with Skype for Business Server 2015.",
"title": "TabURL",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "TabURL"
},
"DisablePhonePresence": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, Skype for Business does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy.",
"title": "DisablePhonePresence",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisablePhonePresence"
},
"ShowRecentContacts": {
"__type_requested": "$true | $false",
"required": false,
"description": "This parameter currently has no effect on the client.",
"title": "ShowRecentContacts",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowRecentContacts"
},
"DisableMeetingSubjectAndLocation": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. When set to True, this detailed information will not be displayed. To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True.",
"title": "DisableMeetingSubjectAndLocation",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableMeetingSubjectAndLocation"
},
"ScopeClass": {
"__type_requested": "Microsoft.Rtc.Management.Core.ScopeClass",
"required": false,
"name": "ScopeClass",
"title": "ScopeClass",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"EnableSQMData": {
"__type_requested": "$true | $false",
"required": false,
"description": "Note: This setting has been deprecated for Skype for Business Server 2015.\nWhen EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Program. However, Skype for Business will provide the user with the option to join the program.\nWhen set to False, the user will not be enrolled in the Customer Experience Improvement Program. In addition, Skype for Business will not give users the option of joining the program. The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program.",
"title": "EnableSQMData",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableSQMData"
},
"ConferenceIMIdleTimeout": {
"__type_requested": "System.Nullable[timespan]",
"required": false,
"description": "Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message.\nThe ConferenceIMIdleTimeout must be less than or equal to 1 hour, and must be specified using the format hours:minutes:seconds. For example, this syntax sets the timeout value to 45 minutes:\n-ConferenceIMIdleTimeout 00:45:00",
"title": "ConferenceIMIdleTimeout",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "ConferenceIMIdleTimeout"
},
"CustomStateUrl": {
"__type_requested": "String",
"required": false,
"description": "Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business allows up to four custom presence states in addition to the built-in states such as Available, Busy, and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol.",
"title": "CustomStateUrl",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "CustomStateUrl"
},
"EnableFullScreenVideo": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls; and, 2) disables video preview for Skype for Business calls. When set to False, full-screen video is not available in Skype for Business, but video preview is available.",
"title": "EnableFullScreenVideo",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableFullScreenVideo"
},
"RateMyCallAllowCustomUserFeedback": {
"__type_requested": "$true | $false",
"required": false,
"description": "PARAMVALUE: $true | $false",
"title": "RateMyCallAllowCustomUserFeedback",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "RateMyCallAllowCustomUserFeedback"
},
"SPSearchCenterInternalURL": {
"__type_requested": "String",
"required": false,
"description": "Internal URL for the SharePoint site used for keyword searches (also known as expert searches). This URL will appear at the bottom of any keyword search results that appear in Skype for Business. If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. (SharePoint offers more search options than Skype for Business does.)\nSPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall.",
"title": "SPSearchCenterInternalURL",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SPSearchCenterInternalURL"
},
"EnableServerConversationHistory": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. This makes it easier for users to retrieve that information from a mobile device.\nThe default value is False ($False).",
"title": "EnableServerConversationHistory",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableServerConversationHistory"
},
"DisableHandsetOnLockedMachine": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer.\nWhen set to False, users will be allowed to use their Polycom handset even if the computer the handset is connected to is locked.",
"title": "DisableHandsetOnLockedMachine",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableHandsetOnLockedMachine"
},
"EnableEnterpriseCustomizedHelp": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization.\nThis parameter has been deprecated for use with Skype for Business Server 2015.",
"title": "EnableEnterpriseCustomizedHelp",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableEnterpriseCustomizedHelp"
},
"DisableFederatedPromptDisplayName": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, any notification dialog box generated when you are added to a federated user's Contacts list will use the federated user's SIP address (for example, sip:[email protected]). When set to False, the notification dialog box will use the federated user's display name (for example, Ken Myer) instead.",
"title": "DisableFederatedPromptDisplayName",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableFederatedPromptDisplayName"
},
"Tenant": {
"__type_requested": "Guid",
"required": false,
"description": "Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client policy is being created. For example:\n-Tenant \"38aad667-af54-4397-aaa7-e94c79ec2308\"\nYou can return the tenant ID for each of your Skype for Business Online tenants by running this command:\nGet-CsTenant | Select-Object DisplayName, TenantID",
"title": "Tenant",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Tenant"
},
"DisableInkIM": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Tablet PC ink.",
"title": "DisableInkIM",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableInkIM"
},
"EnableNotificationForNewSubscribers": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, any time you are added to someone's Contacts list you will receive notification that you have been added to the list. In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. When set to False, you will not be notified if you are added to someone's Contacts list.",
"title": "EnableNotificationForNewSubscribers",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableNotificationForNewSubscribers"
},
"ExcludedContactFolders": {
"__type_requested": "String",
"required": false,
"description": "Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. Multiple folders can be specified by separating the folder names using semicolons; for example, -ExcludedContactFolders \"SenderPhotoContacts;OtherContacts\".",
"title": "ExcludedContactFolders",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "ExcludedContactFolders"
},
"EnableVOIPCallDefault": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature.\nThis policy setting only affects the initial state of the click-to-call feature. If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy.",
"title": "EnableVOIPCallDefault",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableVOIPCallDefault"
},
"CustomizedHelpUrl": {
"__type_requested": "String",
"required": false,
"description": "URL for custom help set up by an organization. This help, rather than the default product help, will be displayed any time a user clicks the Help menu in Skype for Business.\nCustomized help will not be available unless you also set EnableEnterpriseCustomizedHelp to True.\nThis parameter has been deprecated for use with Skype for Business Server 2015.",
"title": "CustomizedHelpUrl",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "CustomizedHelpUrl"
},
"EnableEventLogging": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server 2015) are recorded in the event log.",
"title": "EnableEventLogging",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableEventLogging"
},
"DisableEmailComparisonCheck": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, Skype for Business will not attempt to verify that any currently running instance of Microsoft Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer's user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business.\nWhen set to False, Skype for Business will use SMTP addresses to verify that Outlook and Skype for Business are running under the same account. If the SMTP addresses do not match, then contact and calendar data in Outlook will not be incorporated into Skype for Business.",
"title": "DisableEmailComparisonCheck",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableEmailComparisonCheck"
},
"EnableURL": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, hyperlinks embedded in an instant message will be \"clickable;\" that is, users can click that link and their web browser will open to the specified location. When set to False, hyperlinks will appear in instant messages as plain text. To navigate to the location, users will need to copy the link text and paste it into their web browser.",
"title": "EnableURL",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableURL"
},
"Identity": {
"__type_requested": "string",
"required": true,
"description": "Unique Identity to be assigned to the new policy. New client policies can be created at the site or per-user scope. To create a new site policy, use the prefix \"site:\" and the name of the site as your Identity. For example, use this syntax to create a new policy for the Redmond site: -Identity site:Redmond. To create a new per-user policy, use an identity similar to this: -Identity SalesClientPolicy.",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Identity"
},
"SearchPrefixFlags": {
"__type_requested": "System.Nullable[uint16]",
"required": false,
"description": "Represents the Address Book attributes that should be used any time a user searches for a new contact. The search prefix flags are constructed as a binary number like 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. The attributes in the binary value are (from right to left):\nPrimary email address\nEmail alias\nAll email addresses\nCompany\nDisplay name\nFirst name\nLast name\nThe binary value 1110111 means that all attributes should be searched except attribute 4: Company. To search only last name, first name, and display name you would construct this value:\n1110000\nAfter the binary value has been constructed, it must then be converted to a decimal value before being assigned to SearchPrefixFlags. To convert a binary number to a decimal number, you can use the a Windows PowerShell command similar to this:\n[Convert]::ToInt32(\"1110111\", 2)",
"title": "SearchPrefixFlags",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "SearchPrefixFlags"
},
"P2PAppSharingEncryption": {
"__type_requested": "Microsoft.Rtc.Management.WritableConfig.Policy.Client.P2PAppSharingEncryption",
"required": false,
"description": "Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. Allowed values are:\nSupported. Desktop and application sharing data will be encrypted, if possible.\nEnforced. Desktop and application sharing data must be encrypted. If the data cannot be encrypted, then desktop and application sharing will not be enabled for the conversation.\nNotSupported. Desktop and application sharing data will not be encrypted.",
"title": "P2PAppSharingEncryption",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "P2PAppSharingEncryption"
},
"DisableFreeBusyInfo": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this:\nCalendar: Free until 2:00 PM",
"title": "DisableFreeBusyInfo",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableFreeBusyInfo"
},
"HotdeskingTimeout": {
"__type_requested": "timespan",
"required": false,
"description": "Timeout interval for a user logged on to a hot-desked phone. (A hot-desked phone is a phone running Skype for Business Phone Edition that is located in a shared workspace, and that users can log on to by using their Skype for Business Server 2015 account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desked phone. When specifying a hot desking timeout you must use the format hours:minutes:seconds. For example, this syntax sets the hot desking timeout interval to 45 minutes:\n-HotdeskingTimeout 00:45:00\nNote that this policy setting applies only to common area phones and not to users. The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30).",
"title": "HotdeskingTimeout",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "HotdeskingTimeout"
},
"SPSearchInternalURL": {
"__type_requested": "String",
"required": false,
"description": "Internal URL for the SharePoint site used for keyword searches (also known as expert searches). Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search.",
"title": "SPSearchInternalURL",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SPSearchInternalURL"
},
"HelpEnvironment": {
"__type_requested": "String",
"required": false,
"description": "When set to Office 365, the Skype for Business Online client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. You can either set HelpEnvironment to Office 365 or to a null value ($Null). If set to a null value (the default value) then the on-premises help will be shown to users.",
"title": "HelpEnvironment",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "HelpEnvironment"
},
"RateMyCallDisplayPercentage": {
"__type_requested": "uint16",
"required": false,
"description": "PARAMVALUE: UInt16",
"title": "RateMyCallDisplayPercentage",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "RateMyCallDisplayPercentage"
},
"EnableMediaRedirection": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. Media redirection typically results in lower bandwidth usage, higher server scalability, and a more-optimal user experience compared to similar techniques such as device remoting or codec compression.",
"title": "EnableMediaRedirection",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableMediaRedirection"
},
"EnableClientMusicOnHold": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False.",
"title": "EnableClientMusicOnHold",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableClientMusicOnHold"
},
"EnableSkypeUI": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client.",
"title": "EnableSkypeUI",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableSkypeUI"
},
"EnableIMAutoArchiving": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, a transcript of every instant messaging session that a user takes part in will be saved to the Conversation History folder in Microsoft Outlook. When set to False, these transcripts will not be saved automatically. (However, users will have the option to manually save instant messaging transcripts.)",
"title": "EnableIMAutoArchiving",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableIMAutoArchiving"
},
"EnableConversationWindowTabs": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. This type of information is available only for custom applications that use the Microsoft Unified Communications APIs. For example, customer service or support team personnel can automatically access related information while chatting with someone.\nWhen set to False, supplemental information will not be displayed in a separate browser window. Although the user can still take part in an instant messaging session he or she will not have access to any additional information that accompanies the session.\nThis parameter has been deprecated for use with Skype for Business Server 2015.",
"title": "EnableConversationWindowTabs",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableConversationWindowTabs"
},
"Description": {
"__type_requested": "String",
"required": false,
"description": "Allows administrators to provide additional information about a policy. For example, the Description might indicate which users the policy should be assigned to.",
"title": "Description",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "Description"
},
"EnableAppearOffline": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True an additional presence state, Appear Offline, is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls and respond to instant messages. When set to False, the Appear Offline presence state will not be available in Skype for Business.",
"title": "EnableAppearOffline",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableAppearOffline"
},
"EnableExchangeDelegateSync": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, delegates that a user has configured in Microsoft Exchange will be allowed to schedule meetings for that user.",
"title": "EnableExchangeDelegateSync",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableExchangeDelegateSync"
},
"MAPIPollInterval": {
"__type_requested": "System.Nullable[timespan]",
"required": false,
"description": "Important: This parameter has been deprecated for use with Skype for Business Server 2015.\nFor users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. To configure the MAPI poll interval, use the format hours:minutes:seconds. For example, this command sets the MAPI poll interval to 45 minutes:\n-MapiPollInterval 00:45:00",
"title": "MAPIPollInterval",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "MAPIPollInterval"
},
"DisableRTFIM": {
"__type_requested": "$true | $false",
"required": false,
"description": "When both this setting and the DisableHtmlIm setting are set to True, prevents rich text formatting (for example, different fonts, font sizes, and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages.",
"title": "DisableRTFIM",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisableRTFIM"
},
"ShowSharepointPhotoEditLink": {
"__type_requested": "$true | $false",
"required": false,
"description": "If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on their SharePoint My Site. The default value is False, which means that Skype for Business will not include a link to the SharePoint My Site.",
"title": "ShowSharepointPhotoEditLink",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "ShowSharepointPhotoEditLink"
},
"EnableHighPerformanceP2PAppSharing": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. The default value is False.",
"title": "EnableHighPerformanceP2PAppSharing",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableHighPerformanceP2PAppSharing"
},
"Element": {
"__type_requested": "System.Xml.Linq.XElement",
"required": false,
"name": "Element",
"title": "Element",
"__type_mapping_type": "Unknown",
"readonly": true,
"type": "string",
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string"
},
"SPSearchExternalURL": {
"__type_requested": "String",
"required": false,
"description": "External URL for the SharePoint site used for keyword searches (also known as expert searches). Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search.",
"title": "SPSearchExternalURL",
"__type_mapping_type": "String",
"readonly": false,
"type": "string",
"name": "SPSearchExternalURL"
},
"DisablePoorNetworkWarnings": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, Skype for Business will not display warnings about poor network quality.",
"title": "DisablePoorNetworkWarnings",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "DisablePoorNetworkWarnings"
},
"BlockConversationFromFederatedContacts": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, contacts from outside your organization will not be allowed to initiate instant messaging conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long as the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization.",
"title": "BlockConversationFromFederatedContacts",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "BlockConversationFromFederatedContacts"
},
"EnableHighPerformanceConferencingAppSharing": {
"__type_requested": "$true | $false",
"required": false,
"description": "When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. However, this improved performance will reduce the system resources and network bandwidth available to other applications.",
"title": "EnableHighPerformanceConferencingAppSharing",
"__type_mapping_type": "Boolean",
"readonly": false,
"type": "boolean",
"name": "EnableHighPerformanceConferencingAppSharing"
},
"WebServicePollInterval": {
"__type_requested": "System.Nullable[timespan]",
"required": false,
"description": "For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. To configure the Web Service poll interval, use the format hours:minutes:seconds. For example, this command sets the Web Service poll interval to 45 minutes:\n-WebServicePollInterval 00:45:00\nNote that this setting does not apply to users whose email account is on Exchange 2003. For those users, calendar retrieval is managed using MAPIPollInterval.",
"title": "WebServicePollInterval",
"__type_mapping_type": "Unknown",
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "WebServicePollInterval"
},
"IMLatencyErrorThreshold": {
"__type_requested": "UInt32",
"required": false,
"description": "If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER.",
"title": "IMLatencyErrorThreshold",
"__type_mapping_type": "Integer",
"readonly": false,
"type": "integer",
"name": "IMLatencyErrorThreshold"
}
},
"schema_version": "1150"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/skypeforbusinesshybrid/CsClientPolicy/[pkid1]", "/api/v0/device/skypeforbusinesshybrid/CsClientPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsClientPolicy/?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/CsClientPolicy |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/skypeforbusinesshybrid/CsClientPolicy |
|
{"hrefs": ["/api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid1]", "/api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/skypeforbusinesshybrid/CsClientPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/export/ |
|
{ "hrefs":["/api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid1]", "/api/device/skypeforbusinesshybrid/CsClientPolicy/[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/CsClientPolicy and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsClientPolicy.
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsClientPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/skypeforbusinesshybrid/CsClientPolicy | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/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/CsClientPolicy/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/CsClientPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/ |
|
The device/skypeforbusinesshybrid/CsClientPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/skypeforbusinesshybrid/CsClientPolicy instances)
{
"operations": [
"cs_client_policy",
"move"
],
"pagination": {
"direction": "asc",
"order_by": "Identity",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/skypeforbusinesshybrid/CsClientPolicy/?skip=0&limit=3&order_by=Identity&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/CsClientPolicy/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/CsClientPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/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/CsClientPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"cs_client_policy": {
"support_async": true,
"class": "custom",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/+cs_client_policy/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Cs Client Policy"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/skypeforbusinesshybrid/CsClientPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/skypeforbusinesshybrid/CsClientPolicy",
"model_specific_actions": [
"list",
"get",
"cs_client_policy",
"powershell_disable",
"powershell_enable",
"powershell_move",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "Identity",
"title": "Identity"
},
{
"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/skypeforbusinesshybrid/CsClientPolicy. | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/skypeforbusinesshybrid/CsClientPolicy as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/skypeforbusinesshybrid/CsClientPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/skypeforbusinesshybrid/CsClientPolicy | 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/CsClientPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/[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/CsClientPolicy and the JSON format can be used to import instances of device/skypeforbusinesshybrid/CsClientPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/ | hierarchy=[hierarchy] | The device/skypeforbusinesshybrid/CsClientPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/skypeforbusinesshybrid/CsClientPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Powershell Disable | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/+powershell_disable/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Powershell Enable | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/+powershell_enable/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Powershell Move | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/+powershell_move/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/skypeforbusinesshybrid/CsClientPolicy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |