[Index]
Model ref.: device/exchangeonline/ActiveSyncMailboxPolicy
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": {
"MinDevicePasswordComplexCharacters": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The MinDevicePasswordComplexCharacters parameter specifies the minimum number of complex characters required in a device password. A complex character isn't a letter.",
"title": "MinDevicePasswordComplexCharacters",
"required": false,
"readonly": false,
"type": "integer",
"name": "MinDevicePasswordComplexCharacters"
},
"PSComputerName": {
"__type_requested": "System.String",
"required": false,
"name": "PSComputerName",
"title": "PSComputerName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AdminDisplayName": {
"__type_requested": "System.String",
"required": false,
"name": "AdminDisplayName",
"title": "AdminDisplayName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"UNCAccessEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The UNCAccessEnabled parameter specifies whether access to Microsoft Windows file shares is enabled. Access to specific shares is configured on the Microsoft Exchange ActiveSync virtual directory.",
"title": "UNCAccessEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "UNCAccessEnabled"
},
"AllowPOPIMAPEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowPOPIMAPEmail parameter specifies whether the user can configure a POP3 or IMAP4 email account on the device. The default value is $true.",
"title": "AllowPOPIMAPEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowPOPIMAPEmail"
},
"AllowDesktopSync": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowDesktopSync parameter specifies whether the mobile phone can synchronize with a desktop computer through a cable. The default value is $true.",
"title": "AllowDesktopSync",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowDesktopSync"
},
"IsDefaultPolicy": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy.",
"title": "IsDefaultPolicy",
"required": false,
"readonly": false,
"type": "boolean",
"name": "IsDefaultPolicy"
},
"AllowBrowser": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowBrowser parameter specifies whether Microsoft Pocket Internet Explorer is allowed on the mobile phone. The default value is $true. This parameter doesn't affect third-party browsers.",
"title": "AllowBrowser",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowBrowser"
},
"MaxDevicePasswordFailedAttempts": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxDevicePasswordFailedAttempts parameter specifies the number of attempts a user can make to enter the correct password for the device. You can enter any number from 4 through 16. The default value is 8.",
"title": "MaxDevicePasswordFailedAttempts",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxDevicePasswordFailedAttempts"
},
"DeviceEncryptionEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The DeviceEncryptionEnabled parameter, when set to $true, enables device encryption on the mobile phone. The default value is $false. Currently, only the storage card can be encrypted on devices running Windows Mobile 6.0 or later. We recommend that you don't use this setting and use the RequireStorageCardEncryption parameter instead.",
"title": "DeviceEncryptionEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "DeviceEncryptionEnabled"
},
"AllowRemoteDesktop": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowRemoteDesktop parameter specifies whether the mobile phone can initiate a remote desktop connection. The default value is $true.",
"title": "AllowRemoteDesktop",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowRemoteDesktop"
},
"RequireStorageCardEncryption": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireStorageCardEncryption parameter specifies whether encryption of a storage card is required. The default value is $true.",
"title": "RequireStorageCardEncryption",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireStorageCardEncryption"
},
"Id": {
"__type_requested": "System.String",
"required": false,
"name": "Id",
"title": "Id",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"DevicePolicyRefreshInterval": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The DevicePolicyRefreshInterval parameter specifies how often the policy is sent from the server to the mobile phone",
"title": "DevicePolicyRefreshInterval",
"required": false,
"readonly": false,
"type": "string",
"name": "DevicePolicyRefreshInterval"
},
"ObjectClass": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,",
"required": false,
"name": "ObjectClass",
"title": "ObjectClass",
"items": {
"type": "string"
},
"__type_mapping_type": "String[]",
"readonly": true,
"type": "array"
},
"WhenChanged": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChanged",
"title": "WhenChanged",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"PSShowComputerName": {
"__type_requested": "System.Boolean",
"required": false,
"name": "PSShowComputerName",
"title": "PSShowComputerName",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"AllowConsumerEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowConsumerEmail parameter specifies whether the mobile phone user can configure a personal email account on the device. The default value is $true.",
"title": "AllowConsumerEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowConsumerEmail"
},
"AllowUnsignedApplications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowUnsignedApplications parameter specifies whether unsigned applications can be installed on the device. The default value is $true.",
"title": "AllowUnsignedApplications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowUnsignedApplications"
},
"WSSAccessEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The WSSAccessEnabled parameter specifies whether access to Microsoft Windows SharePoint Services is enabled. Access to specific shares is configured on the Exchange ActiveSync virtual directory.",
"title": "WSSAccessEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "WSSAccessEnabled"
},
"DevicePasswordHistory": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The DevicePasswordHistory parameter specifies the number of previously used passwords to store. When a user creates a password, the user can't reuse a stored password that was previously used.",
"title": "DevicePasswordHistory",
"required": false,
"readonly": false,
"type": "integer",
"name": "DevicePasswordHistory"
},
"AllowApplePushNotifications": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "This parameter is available only in the cloud-based service.\nThe AllowApplePushNotifications parameter specifies whether push notifications are allowed for Apple mobile devices. The default value is $true.",
"title": "AllowApplePushNotifications",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowApplePushNotifications"
},
"MobileOTAUpdateMode": {
"__type_requested": "System.String",
"required": false,
"name": "MobileOTAUpdateMode",
"title": "MobileOTAUpdateMode",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"PasswordRecoveryEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The PasswordRecoveryEnabled parameter specifies whether you can store the recovery password for the device on an Exchange server. When set to $true, you can store the recovery password for the device on an Exchange server. The default value is $false. The recovery password can be viewed from either Outlook on the web or the Exchange admin center.",
"title": "PasswordRecoveryEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "PasswordRecoveryEnabled"
},
"MaxInactivityTimeDeviceLock": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxInactivityTimeDeviceLock parameter specifies the length of time that the device can be inactive before the password is required to reactivate the device. You can enter any interval between 30 seconds and 1 hour. The default value is 15 minutes. The format of the parameter is hh.mm:ss, for example, 15:00 = 15 minutes.",
"title": "MaxInactivityTimeDeviceLock",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxInactivityTimeDeviceLock"
},
"AllowSimpleDevicePassword": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowSimpleDevicePassword parameter specifies whether a simple device password is allowed. A simple device password is a password that has a specific pattern, such as 1111 or 1234. The default value is $true.",
"title": "AllowSimpleDevicePassword",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowSimpleDevicePassword"
},
"AllowIrDA": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowIrDA parameter specifies whether infrared connections are allowed to the mobile phone. The default value is $true.",
"title": "AllowIrDA",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowIrDA"
},
"IrmEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The IrmEnabled parameter specifies whether Information Rights Management (IRM) is enabled for the mailbox policy.",
"title": "IrmEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "IrmEnabled"
},
"AllowInternetSharing": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowInternetSharing parameter specifies whether the mobile phone can be used as a modem to connect a computer to the Internet. The default value is $true.",
"title": "AllowInternetSharing",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowInternetSharing"
},
"OrganizationId": {
"__type_requested": "System.String",
"required": false,
"name": "OrganizationId",
"title": "OrganizationId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"ObjectState": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectState",
"title": "ObjectState",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RequireSignedSMIMEAlgorithm": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The RequireSignedSMIMEAlgorithm parameter specifies what required algorithm must be used when signing a message.",
"title": "RequireSignedSMIMEAlgorithm",
"required": false,
"readonly": false,
"type": "string",
"name": "RequireSignedSMIMEAlgorithm"
},
"IsDefault": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The IsDefault parameter specifies whether this policy is the default Mobile Device mailbox policy. The default value is $false. If another policy is currently set as the default, setting this parameter replaces the old default policy with this policy.",
"title": "IsDefault",
"required": false,
"readonly": false,
"type": "boolean",
"name": "IsDefault"
},
"AllowStorageCard": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowStorageCard parameter specifies whether the device can access information stored on a storage card. The default value is $true.",
"title": "AllowStorageCard",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowStorageCard"
},
"MaxEmailHTMLBodyTruncationSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailHTMLBodyTruncationSize parameter specifies the maximum size at which HTML-formatted email messages are synchronized to the device. The value is specified in KB.",
"title": "MaxEmailHTMLBodyTruncationSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailHTMLBodyTruncationSize"
},
"RequireSignedSMIMEMessages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireSignedSMIMEMessages parameter specifies whether the device must send signed S/MIME messages.",
"title": "RequireSignedSMIMEMessages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireSignedSMIMEMessages"
},
"AttachmentsEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AttachmentsEnabled parameter specifies whether the user can download attachments. When set to $false, the user is blocked from downloading attachments. The default value is $true.",
"title": "AttachmentsEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AttachmentsEnabled"
},
"DistinguishedName": {
"__type_requested": "System.String",
"required": false,
"name": "DistinguishedName",
"title": "DistinguishedName",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AlphanumericDevicePasswordRequired": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AlphanumericDevicePasswordRequired parameter specifies whether the device password must be alphanumeric. The default value is $false.",
"title": "AlphanumericDevicePasswordRequired",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AlphanumericDevicePasswordRequired"
},
"AllowHTMLEmail": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowHTMLEmail parameter specifies whether HTML email is enabled on the device. The default value is $true.",
"title": "AllowHTMLEmail",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowHTMLEmail"
},
"OriginatingServer": {
"__type_requested": "System.String",
"required": false,
"name": "OriginatingServer",
"title": "OriginatingServer",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"Name": {
"__type_requested": "String",
"__type_mapping_type": "String",
"description": "The Name parameter specifies the name of the policy.",
"title": "Name",
"required": true,
"readonly": false,
"type": "string",
"name": "Name"
},
"UnapprovedInROMApplicationList": {
"__type_requested": "MultiValuedProperty",
"__type_mapping_type": "String[]",
"description": "The UnapprovedInROMApplicationList parameter specifies a list of applications that can't be run in ROM.",
"title": "UnapprovedInROMApplicationList",
"items": {
"type": "string"
},
"required": false,
"readonly": false,
"type": "array",
"name": "UnapprovedInROMApplicationList"
},
"WhenCreatedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreatedUTC",
"title": "WhenCreatedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"ApprovedApplicationList": {
"__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.SystemConfiguration.ApprovedApplicationCollection",
"__type_mapping_type": "Unknown",
"description": "The ApprovedApplicationList parameter specifies a list of approved applications for the device.",
"title": "ApprovedApplicationList",
"required": false,
"readonly": true,
"__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string",
"type": "string",
"name": "ApprovedApplicationList"
},
"DevicePasswordEnabled": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "When set to $true, the DevicePasswordEnabled parameter specifies that the user set a password for the device. The default value is $false.",
"title": "DevicePasswordEnabled",
"required": false,
"readonly": false,
"type": "boolean",
"name": "DevicePasswordEnabled"
},
"DevicePasswordExpiration": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The DevicePasswordExpiration parameter specifies the length of time, in days, that a password can be used. After this length of time, a new password must be created. The format of the parameter is dd.hh.mm:ss, for example, 24.00:00 = 24 hours.",
"title": "DevicePasswordExpiration",
"required": false,
"readonly": false,
"type": "string",
"name": "DevicePasswordExpiration"
},
"WhenCreated": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenCreated",
"title": "WhenCreated",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"AllowUnsignedInstallationPackages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowUnsignedInstallationPackages parameter specifies whether unsigned installation packages can be run on the device. The default value is $true.",
"title": "AllowUnsignedInstallationPackages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowUnsignedInstallationPackages"
},
"ExchangeVersion": {
"__type_requested": "System.String",
"required": false,
"name": "ExchangeVersion",
"title": "ExchangeVersion",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"RequireEncryptedSMIMEMessages": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireEncryptedSMIMEMessages parameter specifies whether you must encrypt S/MIME messages. The default value is $false.",
"title": "RequireEncryptedSMIMEMessages",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireEncryptedSMIMEMessages"
},
"MaxEmailAgeFilter": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailAgeFilter parameter specifies the maximum number of days of email items to synchronize to the device.\nPossible values are:\nAll\nOneDay\nThreeDays\nOneWeek\nTwoWeeks\nOneMonth\nThreeMonths\nSixMonths",
"title": "MaxEmailAgeFilter",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailAgeFilter"
},
"RunspaceId": {
"__type_requested": "System.Guid",
"required": false,
"name": "RunspaceId",
"title": "RunspaceId",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"AllowNonProvisionableDevices": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "When set to $true, the AllowNonProvisionableDevices parameter enables all devices to synchronize with the computer running Exchange, regardless of whether the device can enforce all the specific settings established in the Mobile Device mailbox policy. This also includes devices managed by a separate device management system. When set to $false, this parameter blocks these devices that aren't provisioned from synchronizing with the server running Exchange. The default value is $false.",
"title": "AllowNonProvisionableDevices",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowNonProvisionableDevices"
},
"RequireManualSyncWhenRoaming": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireManualSyncWhenRoaming parameter specifies whether the device must synchronize manually while roaming. The default value is $false.",
"title": "RequireManualSyncWhenRoaming",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireManualSyncWhenRoaming"
},
"MaxEmailBodyTruncationSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxEmailBodyTruncationSize parameter specifies the maximum size at which email messages are truncated when synchronized to the device. The value is specified in kilobytes (KB).",
"title": "MaxEmailBodyTruncationSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxEmailBodyTruncationSize"
},
"Guid": {
"__type_requested": "System.Guid",
"required": false,
"name": "Guid",
"title": "Guid",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"DomainController": {
"__type_requested": "Fqdn",
"__type_mapping_type": "String",
"description": "This parameter is available only in on-premises Exchange 2016.\nThe DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.",
"title": "DomainController",
"required": false,
"readonly": false,
"type": "string",
"name": "DomainController"
},
"AllowBluetooth": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The AllowBluetooth parameter specifies whether the Bluetooth capabilities of the mobile phone are allowed. The available options are Disable, HandsfreeOnly, and Allow. The default value is Allow.",
"title": "AllowBluetooth",
"required": false,
"readonly": false,
"type": "string",
"name": "AllowBluetooth"
},
"ObjectCategory": {
"__type_requested": "System.String",
"required": false,
"name": "ObjectCategory",
"title": "ObjectCategory",
"__type_mapping_type": "String",
"readonly": true,
"type": "string"
},
"IsValid": {
"__type_requested": "System.Boolean",
"required": false,
"name": "IsValid",
"title": "IsValid",
"__type_mapping_type": "Boolean",
"readonly": true,
"type": "boolean"
},
"RequireDeviceEncryption": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The RequireDeviceEncryption parameter specifies whether encryption is required on the device. The default value is $false.",
"title": "RequireDeviceEncryption",
"required": false,
"readonly": false,
"type": "boolean",
"name": "RequireDeviceEncryption"
},
"AllowSMIMESoftCerts": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowSMIMESoftCerts parameter specifies whether S/MIME software certificates are allowed. The default value is $true.",
"title": "AllowSMIMESoftCerts",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowSMIMESoftCerts"
},
"AllowWiFi": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowWiFi parameter specifies whether wireless Internet access is allowed on the device. The default value is $true.",
"title": "AllowWiFi",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowWiFi"
},
"MinDevicePasswordLength": {
"__type_requested": "Int32",
"__type_mapping_type": "Integer",
"description": "The MinDevicePasswordLength parameter specifies the minimum number of characters in the device password. You can enter any number from 1 through 16. The maximum length a password can be is 16 characters. The default value is 4.",
"title": "MinDevicePasswordLength",
"required": false,
"readonly": false,
"type": "integer",
"name": "MinDevicePasswordLength"
},
"WhenChangedUTC": {
"__type_requested": "System.DateTime",
"__type_mapping_type": "DateTime",
"name": "WhenChangedUTC",
"title": "WhenChangedUTC",
"format": "date-time",
"required": false,
"readonly": true,
"type": "string"
},
"RequireEncryptionSMIMEAlgorithm": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The RequireEncryptionSMIMEAlgorithm parameter specifies what required algorithm must be used when encrypting a message.",
"title": "RequireEncryptionSMIMEAlgorithm",
"required": false,
"readonly": false,
"type": "string",
"name": "RequireEncryptionSMIMEAlgorithm"
},
"MaxCalendarAgeFilter": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxCalendarAgeFilter parameter specifies the maximum range of calendar days that can be synchronized to the device. Possible values are:\nAll\nTwoWeeks\nOneMonth\nThreeMonths\nSixMonths",
"title": "MaxCalendarAgeFilter",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxCalendarAgeFilter"
},
"AllowTextMessaging": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowTextMessaging parameter specifies whether text messaging is allowed from the device. The default value is $true.",
"title": "AllowTextMessaging",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowTextMessaging"
},
"Identity": {
"__type_requested": "System.String",
"required": false,
"name": "Identity",
"title": "Identity",
"__type_mapping_type": "String",
"readonly": true,
"type": "string",
"description": "The Identity parameter specifies the policy name."
},
"AllowMobileOTAUpdate": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowMobileOTAUpdate parameter specifies whether certain updates are seen by devices that implemented support for this restricting functionality. Further control can be specified via the MobileOTAUpdateMode parameter.",
"title": "AllowMobileOTAUpdate",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowMobileOTAUpdate"
},
"AllowSMIMEEncryptionAlgorithmNegotiation": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The AllowSMIMEEncryptionAlgorithmNegotiation parameter specifies whether the messaging application on the device can negotiate the encryption algorithm in case a recipient's certificate doesn't support the specified encryption algorithm.",
"title": "AllowSMIMEEncryptionAlgorithmNegotiation",
"required": false,
"readonly": false,
"type": "string",
"name": "AllowSMIMEEncryptionAlgorithmNegotiation"
},
"AllowExternalDeviceManagement": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowExternalDeviceManagement parameter specifies whether an external device management program is allowed to manage the device.",
"title": "AllowExternalDeviceManagement",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowExternalDeviceManagement"
},
"AllowCamera": {
"__type_requested": "$true | $false",
"__type_mapping_type": "Boolean",
"description": "The AllowCamera parameter specifies whether the mobile phone's camera is allowed. The default value is $true.",
"title": "AllowCamera",
"required": false,
"readonly": false,
"type": "boolean",
"name": "AllowCamera"
},
"MaxAttachmentSize": {
"__type_requested": "System.String",
"__type_mapping_type": "String",
"description": "The MaxAttachmentSize parameter specifies the maximum size of attachments that can be downloaded to the mobile phone. The default value is Unlimited.",
"title": "MaxAttachmentSize",
"required": false,
"readonly": false,
"type": "string",
"name": "MaxAttachmentSize"
}
},
"schema_version": "2017.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/add/ |
|
The GUI Add form of device/exchangeonline/ActiveSyncMailboxPolicy as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/device/exchangeonline/ActiveSyncMailboxPolicy/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid1]", "/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid1]", "/api/v0/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangeonline/ActiveSyncMailboxPolicy |
|
{"hrefs": ["/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangeonline/ActiveSyncMailboxPolicy |
|
{"hrefs": ["/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid1]", "/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangeonline/ActiveSyncMailboxPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy/export/ |
|
{ "hrefs":["/api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid1]", "/api/device/exchangeonline/ActiveSyncMailboxPolicy/[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/exchangeonline/ActiveSyncMailboxPolicy and the JSON format can be used to import instances of device/exchangeonline/ActiveSyncMailboxPolicy.
GET http://[host-proxy]/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/exchangeonline/ActiveSyncMailboxPolicy | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy/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/exchangeonline/ActiveSyncMailboxPolicy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/ |
|
The device/exchangeonline/ActiveSyncMailboxPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangeonline/ActiveSyncMailboxPolicy instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "Name",
"direction": "asc",
"current": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/?skip=0&limit=3&order_by=Name&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/exchangeonline/ActiveSyncMailboxPolicy",
"summary_attrs": [
{
"name": "Name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"get",
"list",
"add",
"remove",
"update",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "2017.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/exchangeonline/ActiveSyncMailboxPolicy",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/exchangeonline/ActiveSyncMailboxPolicy/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/exchangeonline/ActiveSyncMailboxPolicy. | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangeonline/ActiveSyncMailboxPolicy as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangeonline/ActiveSyncMailboxPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangeonline/ActiveSyncMailboxPolicy | 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/exchangeonline/ActiveSyncMailboxPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[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/exchangeonline/ActiveSyncMailboxPolicy and the JSON format can be used to import instances of device/exchangeonline/ActiveSyncMailboxPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid] | hierarchy=[hierarchy] | The device/exchangeonline/ActiveSyncMailboxPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangeonline/ActiveSyncMailboxPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/exchangeonline/ActiveSyncMailboxPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |