[Index]
Model ref.: device/exchange/MailboxDatabase
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": { "PublicFolderDatabase": { "__type_requested": "", "required": false, "description": "The PublicFolderDatabase parameter specifies the associated public folder database for the new mailbox database.", "title": "PublicFolderDatabase", "__type_mapping_type": "Unknown", "name": "PublicFolderDatabase", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ReplayCheckpointDepth": { "__type_requested": "", "required": false, "name": "ReplayCheckpointDepth", "title": "ReplayCheckpointDepth", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Recovery": { "__type_requested": "SwitchParameter", "required": true, "description": "The Recovery parameter specifies that the new database is designated as a recovery database.", "title": "Recovery", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "Recovery" }, "CurrentSchemaVersion": { "__type_requested": "", "required": false, "name": "CurrentSchemaVersion", "title": "CurrentSchemaVersion", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "EdbFilePath": { "__type_requested": "System.String", "required": false, "description": "The EdbFilePath parameter specifies the path to the database files. The default value is %programfiles%\\Microsoft\\Exchange Server\\V15\\Mailbox\\<Database name>.edb.", "title": "EdbFilePath", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "EdbFilePath" }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "OfflineAddressBook": { "__type_requested": "", "required": false, "description": "The OfflineAddressBook parameter specifies the associated offline address book (OAB) for the new mailbox database.", "title": "OfflineAddressBook", "__type_mapping_type": "Unknown", "name": "OfflineAddressBook", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "JournalRecipient": { "__type_requested": "RecipientIdParameter", "required": false, "description": "The JournalRecipient parameter specifies the mailbox to which journal reports are sent.", "title": "JournalRecipient", "__type_mapping_type": "Unknown", "name": "JournalRecipient", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SnapshotLastCopyBackup": { "__type_requested": "", "required": false, "name": "SnapshotLastCopyBackup", "title": "SnapshotLastCopyBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AutoDagExcludeFromMonitoring": { "__type_requested": "$true | $false", "required": false, "description": "The AutoDagExcludeFromMonitoring parameter specifies that the database being created should not be monitored by managed availability.", "title": "AutoDagExcludeFromMonitoring", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "AutoDagExcludeFromMonitoring" }, "DumpsterServersNotAvailable": { "__type_requested": "", "required": false, "name": "DumpsterServersNotAvailable", "title": "DumpsterServersNotAvailable", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "BackgroundDatabaseMaintenanceSerialization": { "__type_requested": "", "required": false, "name": "BackgroundDatabaseMaintenanceSerialization", "title": "BackgroundDatabaseMaintenanceSerialization", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DatabaseExtensionSize": { "__type_requested": "", "required": false, "name": "DatabaseExtensionSize", "title": "DatabaseExtensionSize", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DatabaseGroup": { "__type_requested": "System.String", "required": false, "name": "DatabaseGroup", "title": "DatabaseGroup", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "OriginatingServer": { "__type_requested": "System.String", "required": false, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "IsPublicFolderDatabase": { "__type_requested": "System.Boolean", "required": false, "name": "IsPublicFolderDatabase", "title": "IsPublicFolderDatabase", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "TemporaryDataFolderPath": { "__type_requested": "", "required": false, "name": "TemporaryDataFolderPath", "title": "TemporaryDataFolderPath", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DatabaseCopies": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseCopy[]", "required": false, "name": "DatabaseCopies", "title": "DatabaseCopies", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AdminDisplayVersion": { "__type_requested": "System.String", "required": false, "name": "AdminDisplayVersion", "title": "AdminDisplayVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Organization": { "__type_requested": "System.String", "required": false, "name": "Organization", "title": "Organization", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ExchangeVersion": { "__type_requested": "System.String", "required": false, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DataMoveReplicationConstraint": { "__type_requested": "System.String", "required": false, "name": "DataMoveReplicationConstraint", "title": "DataMoveReplicationConstraint", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The DataMoveReplicationConstraint parameter specifies the throttling behavior for high availability mailbox moves. The possible values include:\nNone Moves shouldn't be throttled to ensure high availability. Use this setting if the database isn't part of a database availability group (DAG).\nSecondCopy At least one passive mailbox database copy must have the most recent changes synchronized. This is the default value. Use this setting to indicate that the database is replicated to one or more mailbox database copies.\nSecondDatacenter At least one passive mailbox database copy in another Active Directory site must have the most recent changes replicated. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites.\nAllDatacenters At least one passive mailbox database copy in each Active Directory site must have the most recent changes replicated. Use this setting to indicate that the database is replicated to database copies in multiple Active Directory sites.\nAllCopies All copies of the database must have the most recent changes replicated. Use this setting to indicate that the database is replicated to one or more mailbox database copies.\nAny value other than None enables the Microsoft Exchange Mailbox Replication service to coordinate with Active Manager. For more information, see Active Manager." }, "LastCopyBackup": { "__type_requested": "", "required": false, "name": "LastCopyBackup", "title": "LastCopyBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "InvalidDatabaseCopies": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseCopy[]", "required": false, "name": "InvalidDatabaseCopies", "title": "InvalidDatabaseCopies", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DatabaseCreated": { "__type_requested": "System.Boolean", "required": false, "name": "DatabaseCreated", "title": "DatabaseCreated", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "ReplicationType": { "__type_requested": "System.String", "required": false, "name": "ReplicationType", "title": "ReplicationType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "DeletedItemRetention": { "__type_requested": "System.String", "required": false, "name": "DeletedItemRetention", "title": "DeletedItemRetention", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The DeletedItemRetention parameter specifies the length of time to keep deleted items.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a 15-hour interval, enter 15:00:00. The maximum length of time to retain deleted items is 24,855 days. By default, deleted items are retained for 14 days. This attribute applies to all mailboxes in this mailbox database that don't have their own item retention attribute set." }, "RunspaceId": { "__type_requested": "System.Guid", "required": false, "name": "RunspaceId", "title": "RunspaceId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "Guid": { "__type_requested": "System.Guid", "required": false, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MaintenanceSchedule": { "__type_requested": "Schedule", "required": false, "description": "This parameter has been deprecated in Exchange 2013 and it no longer does anything.", "title": "MaintenanceSchedule", "__type_mapping_type": "Unknown", "name": "MaintenanceSchedule", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MaximumReplayPreReadPages": { "__type_requested": "", "required": false, "name": "MaximumReplayPreReadPages", "title": "MaximumReplayPreReadPages", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "OrganizationId": { "__type_requested": "System.String", "required": false, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "ActivationPreference": { "__type_requested": "Deserialized.System.Collections.Generic.KeyValuePair`2[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "ActivationPreference", "title": "ActivationPreference", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MountedOnServer": { "__type_requested": "", "required": false, "name": "MountedOnServer", "title": "MountedOnServer", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MaximumCursors": { "__type_requested": "", "required": false, "name": "MaximumCursors", "title": "MaximumCursors", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SnapshotLastDifferentialBackup": { "__type_requested": "", "required": false, "name": "SnapshotLastDifferentialBackup", "title": "SnapshotLastDifferentialBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MasterType": { "__type_requested": "System.String", "required": false, "name": "MasterType", "title": "MasterType", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "TruncationLagTimes": { "__type_requested": "Deserialized.System.Collections.Generic.KeyValuePair`2[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "TruncationLagTimes", "title": "TruncationLagTimes", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IndexEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "IndexEnabled", "title": "IndexEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The IndexEnabled parameter specifies whether Exchange Search indexes this mailbox database. The two possible values are $true or $false. The default value is $true." }, "RpcClientAccessServer": { "__type_requested": "System.String", "required": false, "name": "RpcClientAccessServer", "title": "RpcClientAccessServer", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "OriginalDatabase": { "__type_requested": "", "required": false, "name": "OriginalDatabase", "title": "OriginalDatabase", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DistinguishedName": { "__type_requested": "System.String", "required": false, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MaximumOpenTables": { "__type_requested": "", "required": false, "name": "MaximumOpenTables", "title": "MaximumOpenTables", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PreferredVersionStorePages": { "__type_requested": "", "required": false, "name": "PreferredVersionStorePages", "title": "PreferredVersionStorePages", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "LogFolderPath": { "__type_requested": "System.String", "required": false, "description": "The LogFolderPath parameter specifies the folder location for log files.", "title": "LogFolderPath", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "LogFolderPath" }, "Server": { "__type_requested": "System.String", "required": true, "description": "The Server parameter specifies the server on which you want to create the database.", "title": "Server", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Server" }, "AdministrativeGroup": { "__type_requested": "System.String", "required": false, "name": "AdministrativeGroup", "title": "AdministrativeGroup", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "MailboxProvisioningAttributes": { "__type_requested": "", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "MailboxProvisioningAttributes", "__type_mapping_type": "Unknown", "name": "MailboxProvisioningAttributes", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SnapshotLastFullBackup": { "__type_requested": "", "required": false, "name": "SnapshotLastFullBackup", "title": "SnapshotLastFullBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MaximumBackgroundDatabaseMaintenanceInterval": { "__type_requested": "", "required": false, "name": "MaximumBackgroundDatabaseMaintenanceInterval", "title": "MaximumBackgroundDatabaseMaintenanceInterval", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DomainController": { "__type_requested": "Fqdn", "required": false, "description": "The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.", "title": "DomainController", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "DomainController" }, "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" }, "LastFullBackup": { "__type_requested": "", "required": false, "name": "LastFullBackup", "title": "LastFullBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ProhibitSendReceiveQuota": { "__type_requested": "System.String", "required": false, "name": "ProhibitSendReceiveQuota", "title": "ProhibitSendReceiveQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The ProhibitSendReceiveQuota parameter specifies the mailbox size at which the user associated with this mailbox can no longer send or receive messages. This attribute applies to all mailboxes in this mailbox database that don't have their own prohibit send receive quota attributes set.\nYou must specify either an integer or unlimited." }, "Servers": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADObjectId[]", "required": false, "name": "Servers", "title": "Servers", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ObjectState": { "__type_requested": "System.String", "required": false, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AllDatabaseCopies": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.SystemConfiguration.DatabaseCopy[]", "required": false, "name": "AllDatabaseCopies", "title": "AllDatabaseCopies", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IsExcludedFromProvisioningBySpaceMonitoring": { "__type_requested": "System.Boolean", "required": false, "name": "IsExcludedFromProvisioningBySpaceMonitoring", "title": "IsExcludedFromProvisioningBySpaceMonitoring", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "IsExcludedFromProvisioning": { "__type_requested": "$true | $false", "required": false, "description": "The IsExcludedFromProvisioning parameter specifies whether this database is considered by the mailbox provisioning load balancer. If the IsExcludedFromProvisioning parameter is set to $true, no new mailboxes are automatically added to this database.", "title": "IsExcludedFromProvisioning", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsExcludedFromProvisioning" }, "IssueWarningQuota": { "__type_requested": "System.String", "required": false, "name": "IssueWarningQuota", "title": "IssueWarningQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The IssueWarningQuota parameter specifies the mailbox size at which a warning message is sent to the user.\nThis attribute applies to all mailboxes in this mailbox database that don't have their own warning quota attribute set. You must specify either an integer or unlimited. The default value is 1.9 gigabytes (GB)." }, "AdminDisplayName": { "__type_requested": "System.String", "required": false, "name": "AdminDisplayName", "title": "AdminDisplayName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AutoDatabaseMountDial": { "__type_requested": "System.String", "required": false, "name": "AutoDatabaseMountDial", "title": "AutoDatabaseMountDial", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "MasterServerOrAvailabilityGroup": { "__type_requested": "System.String", "required": false, "name": "MasterServerOrAvailabilityGroup", "title": "MasterServerOrAvailabilityGroup", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RecoverableItemsQuota": { "__type_requested": "System.String", "required": false, "name": "RecoverableItemsQuota", "title": "RecoverableItemsQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The RecoverableItemsQuota parameter specifies the limit for the Recovery Items folder. When you reach the quota limit, you can't put any more items in the Recovery Items folder." }, "BackgroundDatabaseMaintenance": { "__type_requested": "System.Boolean", "required": false, "name": "BackgroundDatabaseMaintenance", "title": "BackgroundDatabaseMaintenance", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The BackgroundDatabaseMaintenance parameter specifies whether the Extensible Storage Engine (ESE) performs database maintenance. The two possible values are $true or $false. If you specify $true, the mailbox database reads the object during database mount and initializes the database to perform the background database maintenance. If you specify $false, the mailbox database reads the object during database mount and initializes the database without the option to perform the background database maintenance." }, "CachePriority": { "__type_requested": "", "required": false, "name": "CachePriority", "title": "CachePriority", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "MimimumBackgroundDatabaseMaintenanceInterval": { "__type_requested": "", "required": false, "name": "MimimumBackgroundDatabaseMaintenanceInterval", "title": "MimimumBackgroundDatabaseMaintenanceInterval", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DatabaseSize": { "__type_requested": "", "required": false, "name": "DatabaseSize", "title": "DatabaseSize", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "LogCheckpointDepth": { "__type_requested": "", "required": false, "name": "LogCheckpointDepth", "title": "LogCheckpointDepth", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "RecoverableItemsWarningQuota": { "__type_requested": "System.String", "required": false, "name": "RecoverableItemsWarningQuota", "title": "RecoverableItemsWarningQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The RecoverableItemsWarningQuota parameter specifies the quota for when a warning event is entered in Event Viewer." }, "MaximumTemporaryTables": { "__type_requested": "", "required": false, "name": "MaximumTemporaryTables", "title": "MaximumTemporaryTables", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IsSuspendedFromProvisioning": { "__type_requested": "$true | $false", "required": false, "description": "The IsSuspendedFromProvisioning parameter specifies whether this database is temporarily considered by the mailbox provisioning load balancer.", "title": "IsSuspendedFromProvisioning", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsSuspendedFromProvisioning" }, "Mounted": { "__type_requested": "", "required": false, "name": "Mounted", "title": "Mounted", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AllowFileRestore": { "__type_requested": "System.Boolean", "required": false, "name": "AllowFileRestore", "title": "AllowFileRestore", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The AllowFileRestore parameter specifies whether to allow restoring a database from a backup. The two possible values are $true or $false. If you specify $true, the command allows a database that doesn't match the database entry in Active Directory to be mounted. If you specify $false, the command doesn't allow a database that doesn't match the database entry in Active Directory to be mounted, so you won't be able to replace an existing database with a newly created database." }, "MaximumSessions": { "__type_requested": "", "required": false, "name": "MaximumSessions", "title": "MaximumSessions", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RequestedSchemaVersion": { "__type_requested": "", "required": false, "name": "RequestedSchemaVersion", "title": "RequestedSchemaVersion", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "CachedClosedTables": { "__type_requested": "", "required": false, "name": "CachedClosedTables", "title": "CachedClosedTables", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ReplayBackgroundDatabaseMaintenanceDelay": { "__type_requested": "", "required": false, "name": "ReplayBackgroundDatabaseMaintenanceDelay", "title": "ReplayBackgroundDatabaseMaintenanceDelay", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "IsMailboxDatabase": { "__type_requested": "System.Boolean", "required": false, "name": "IsMailboxDatabase", "title": "IsMailboxDatabase", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "LastDifferentialBackup": { "__type_requested": "", "required": false, "name": "LastDifferentialBackup", "title": "LastDifferentialBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "DumpsterStatistics": { "__type_requested": "SwitchParameter", "required": false, "name": "DumpsterStatistics", "title": "DumpsterStatistics", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The DumpsterStatistics switch specifies that transport dumpster statistics be returned with the database status." }, "ReplayBackgroundDatabaseMaintenance": { "__type_requested": "", "required": false, "name": "ReplayBackgroundDatabaseMaintenance", "title": "ReplayBackgroundDatabaseMaintenance", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Identity": { "__type_requested": "System.String", "required": false, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The Identity parameter specifies a mailbox database. You can use the following values:\nGUID\nDistinguished name (DN)\nDatabase name\nIf you have multiple databases with the same name, the command retrieves all databases with the same name in the specified scope." }, "ReplayCachePriority": { "__type_requested": "", "required": false, "name": "ReplayCachePriority", "title": "ReplayCachePriority", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "MountAtStartup": { "__type_requested": "System.Boolean", "required": false, "name": "MountAtStartup", "title": "MountAtStartup", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The MountAtStartup parameter specifies whether to mount this mailbox database when the Microsoft Exchange Information Store service starts. The two possible values for this parameter are $true or $false." }, "LogFilePrefix": { "__type_requested": "System.String", "required": false, "name": "LogFilePrefix", "title": "LogFilePrefix", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "BackupInProgress": { "__type_requested": "", "required": false, "name": "BackupInProgress", "title": "BackupInProgress", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "LogFileSize": { "__type_requested": "System.Int32", "required": false, "name": "LogFileSize", "title": "LogFileSize", "__type_mapping_type": "Integer", "readonly": true, "type": "integer" }, "ExchangeLegacyDN": { "__type_requested": "System.String", "required": false, "name": "ExchangeLegacyDN", "title": "ExchangeLegacyDN", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "SkipDatabaseLogFolderCreation": { "__type_requested": "SwitchParameter", "required": false, "description": "This parameter is reserved for internal Microsoft use.", "title": "SkipDatabaseLogFolderCreation", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "SkipDatabaseLogFolderCreation" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "MailboxRetention": { "__type_requested": "System.String", "required": false, "name": "MailboxRetention", "title": "MailboxRetention", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The MailboxRetention parameter specifies the length of time to keep deleted mailboxes.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a 15-hour interval, enter 15:00:00. The maximum length of time to retain mailboxes is 24,855 days. By default, deleted mailboxes are retained for 30 days. This attribute applies to all mailboxes in this mailbox database." }, "ProhibitSendQuota": { "__type_requested": "System.String", "required": false, "name": "ProhibitSendQuota", "title": "ProhibitSendQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The ProhibitSendQuota parameter specifies the mailbox size at which users associated with mailboxes in this mailbox database can no longer send messages. This attribute applies to all mailboxes in this mailbox database that don't have their own prohibit send quota attributes set.\nYou must specify either an integer or unlimited." }, "CalendarLoggingQuota": { "__type_requested": "System.String", "required": false, "name": "CalendarLoggingQuota", "title": "CalendarLoggingQuota", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The CalendarLoggingQuota parameter specifies how much space to allocate for calendar logging information." }, "Description": { "__type_requested": "System.String", "required": false, "name": "Description", "title": "Description", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "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" }, "MaximumVersionStorePages": { "__type_requested": "", "required": false, "name": "MaximumVersionStorePages", "title": "MaximumVersionStorePages", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WorkerProcessId": { "__type_requested": "", "required": false, "name": "WorkerProcessId", "title": "WorkerProcessId", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "LastIncrementalBackup": { "__type_requested": "", "required": false, "name": "LastIncrementalBackup", "title": "LastIncrementalBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ServerName": { "__type_requested": "System.String", "required": false, "name": "ServerName", "title": "ServerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "BackgroundDatabaseMaintenanceDelay": { "__type_requested": "", "required": false, "name": "BackgroundDatabaseMaintenanceDelay", "title": "BackgroundDatabaseMaintenanceDelay", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "Name": { "__type_requested": "String", "required": true, "description": "The Name parameter specifies the name of the new mailbox database.", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "name": "Name" }, "IsExcludedFromInitialProvisioning": { "__type_requested": "SwitchParameter", "required": false, "description": "The IsExcludedFromInitialProvisioning parameter specifies that this database is temporarily not considered by the mailbox provisioning load balancer. If the IsExcludedFromInitialProvisioning parameter is enabled, new mailboxes aren't added automatically to this database.", "title": "IsExcludedFromInitialProvisioning", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "name": "IsExcludedFromInitialProvisioning" }, "LogBuffers": { "__type_requested": "", "required": false, "name": "LogBuffers", "title": "LogBuffers", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "AvailableNewMailboxSpace": { "__type_requested": "", "required": false, "name": "AvailableNewMailboxSpace", "title": "AvailableNewMailboxSpace", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "SnapshotLastIncrementalBackup": { "__type_requested": "", "required": false, "name": "SnapshotLastIncrementalBackup", "title": "SnapshotLastIncrementalBackup", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "QuotaNotificationSchedule": { "__type_requested": "Schedule", "required": false, "description": "This parameter has been deprecated in Exchange 2013 and it no longer does anything.", "title": "QuotaNotificationSchedule", "__type_mapping_type": "Unknown", "name": "QuotaNotificationSchedule", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MaximumPreReadPages": { "__type_requested": "", "required": false, "name": "MaximumPreReadPages", "title": "MaximumPreReadPages", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "ReplayLagTimes": { "__type_requested": "Deserialized.System.Collections.Generic.KeyValuePair`2[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": false, "name": "ReplayLagTimes", "title": "ReplayLagTimes", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": false, "readonly": true, "type": "string" }, "RetainDeletedItemsUntilBackup": { "__type_requested": "System.Boolean", "required": false, "name": "RetainDeletedItemsUntilBackup", "title": "RetainDeletedItemsUntilBackup", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The RetainDeletedItemsUntilBackup parameter specifies whether to retain deleted items until the next backup occurs. The two possible values for this parameter are $true or $false." }, "EventHistoryRetentionPeriod": { "__type_requested": "System.String", "required": false, "name": "EventHistoryRetentionPeriod", "title": "EventHistoryRetentionPeriod", "__type_mapping_type": "String", "readonly": true, "type": "string", "description": "The EventHistoryRetentionPeriod parameter specifies the length of time to keep event data. This event data is stored in the event history table in the Exchange store. It includes information about changes to various objects in the mailbox database. You can use this parameter to prevent the event history table from becoming too large and using too much disk space.\nTo specify a value, enter it as a time span: dd.hh:mm:ss where d = days, h = hours, m = minutes, and s = seconds.\nFor example, to specify a 15-hour interval, enter 15:00:00." }, "CircularLoggingEnabled": { "__type_requested": "System.Boolean", "required": false, "name": "CircularLoggingEnabled", "title": "CircularLoggingEnabled", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean", "description": "The CircularLoggingEnabled parameter specifies whether circular logging is enabled. If this parameter is set to $true, circular logging is enabled. The default value is $false." } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/exchange/MailboxDatabase/add/ |
|
The GUI Add form of device/exchange/MailboxDatabase 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/exchange/MailboxDatabase/ | 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/exchange/MailboxDatabase/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/exchange/MailboxDatabase/[pkid1]", "/api/device/exchange/MailboxDatabase/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchange/MailboxDatabase/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchange/MailboxDatabase/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchange/MailboxDatabase/[pkid1]", "/api/v0/device/exchange/MailboxDatabase/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxDatabase |
|
{"hrefs": ["/api/device/exchange/MailboxDatabase/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchange/MailboxDatabase |
|
{"hrefs": ["/api/device/exchange/MailboxDatabase/[pkid1]", "/api/device/exchange/MailboxDatabase/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchange/MailboxDatabase; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchange/MailboxDatabase/export/ |
|
{ "hrefs":["/api/device/exchange/MailboxDatabase/[pkid1]", "/api/device/exchange/MailboxDatabase/[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/exchange/MailboxDatabase and the JSON format can be used to import instances of device/exchange/MailboxDatabase.
GET http://[host-proxy]/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchange/MailboxDatabase | POST | /api/device/exchange/MailboxDatabase/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/exchange/MailboxDatabase/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchange/MailboxDatabase/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchange/MailboxDatabase/ |
|
The device/exchange/MailboxDatabase schema and all instances as JSON. |
(The list will return 0 to 3 device/exchange/MailboxDatabase instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchange/MailboxDatabase/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/exchange/MailboxDatabase/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchange/MailboxDatabase/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/exchange/MailboxDatabase", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchange/MailboxDatabase/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/exchange/MailboxDatabase/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchange/MailboxDatabase/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchange/MailboxDatabase/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchange/MailboxDatabase/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchange/MailboxDatabase/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchange/MailboxDatabase", "model_specific_actions": [ "get", "list", "add", "remove", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchange/MailboxDatabase. | GET | /api/device/exchange/MailboxDatabase/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchange/MailboxDatabase as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchange/MailboxDatabase/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/exchange/MailboxDatabase/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchange/MailboxDatabase/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchange/MailboxDatabase/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchange/MailboxDatabase | 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/exchange/MailboxDatabase; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchange/MailboxDatabase/[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/exchange/MailboxDatabase and the JSON format can be used to import instances of device/exchange/MailboxDatabase.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchange/MailboxDatabase/[pkid]/ | hierarchy=[hierarchy] | The device/exchange/MailboxDatabase instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchange/MailboxDatabase/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchange/MailboxDatabase. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchange/MailboxDatabase/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |