[Index]
Model ref.: device/exchangehybrid/User
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": { "Title": { "__type_requested": "System.String", "required": true, "name": "Title", "title": "Title", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Title parameter specifies the user's title." }, "OtherHomePhone": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "OtherHomePhone", "title": "OtherHomePhone", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The OtherHomePhone parameter specifies the user's alternative home telephone number." }, "Department": { "__type_requested": "System.String", "required": true, "name": "Department", "title": "Department", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Department parameter specifies the user's department." }, "PSShowComputerName": { "__type_requested": "System.Boolean", "required": false, "name": "PSShowComputerName", "title": "PSShowComputerName", "__type_mapping_type": "Boolean", "readonly": true, "type": "boolean" }, "SidHistory": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.Security.Principal.SecurityIdentifier,", "required": true, "name": "SidHistory", "title": "SidHistory", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "OtherTelephone": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "OtherTelephone", "title": "OtherTelephone", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The OtherTelephone parameter specifies the user's alternative telephone number." }, "Fax": { "__type_requested": "System.String", "required": true, "name": "Fax", "title": "Fax", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Fax parameter specifies the user's fax number." }, "TelephoneAssistant": { "__type_requested": "System.String", "required": true, "name": "TelephoneAssistant", "title": "TelephoneAssistant", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is available only in on-premises Exchange 2013.\nThe TelephoneAssistant parameter specifies the telephone number of the user's assistant." }, "UpgradeRequest": { "__type_requested": "System.String", "required": true, "name": "UpgradeRequest", "title": "UpgradeRequest", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "Company": { "__type_requested": "System.String", "required": true, "name": "Company", "title": "Company", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Company parameter specifies the user's company." }, "VoiceMailSettings": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "VoiceMailSettings", "title": "VoiceMailSettings", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "MobilePhone": { "__type_requested": "System.String", "required": true, "name": "MobilePhone", "title": "MobilePhone", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MobilePhone parameter specifies the user's primary mobile phone number." }, "LastName": { "__type_requested": "System.String", "required": true, "name": "LastName", "title": "LastName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The LastName parameter specifies the user's surname." }, "MailboxProvisioningConstraint": { "__type_requested": "", "required": true, "name": "MailboxProvisioningConstraint", "title": "MailboxProvisioningConstraint", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "GeoCoordinates": { "__type_requested": "GeoCoordinates", "required": true, "description": "The GeoCoordinates parameter specifies the user's physical location in latitude, longitude, and altitude coordinates. Use this parameter to specify the global position of physical resources, such as conference rooms. You have to specify one of the following sets of coordinates; use semicolons to separate the values.\nLatitude and longitude; for example, \"47.644125;-122.122411\"\nLatitude, longitude, and altitude; for example, \"47.644125;-122.122411;161.432\"", "title": "GeoCoordinates", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "GeoCoordinates" }, "InPlaceHoldsRaw": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "InPlaceHoldsRaw", "title": "InPlaceHoldsRaw", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "This parameter is reserved for internal Microsoft use." }, "OriginatingServer": { "__type_requested": "System.String", "required": true, "name": "OriginatingServer", "title": "OriginatingServer", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "WebPage": { "__type_requested": "System.String", "required": true, "name": "WebPage", "title": "WebPage", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The WebPage parameter specifies the user's Web page." }, "Notes": { "__type_requested": "System.String", "required": true, "name": "Notes", "title": "Notes", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Notes parameter specifies additional information about the user." }, "WindowsEmailAddress": { "__type_requested": "System.String", "required": true, "name": "WindowsEmailAddress", "title": "WindowsEmailAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The WindowsEmailAddress parameter specifies the email address of the recipient." }, "IsSoftDeletedByRemove": { "__type_requested": "System.Boolean", "required": true, "name": "IsSoftDeletedByRemove", "title": "IsSoftDeletedByRemove", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "StreetAddress": { "__type_requested": "System.String", "required": true, "name": "StreetAddress", "title": "StreetAddress", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The StreetAddress parameter specifies the user's physical address." }, "ArchiveRelease": { "__type_requested": "System.String", "required": true, "name": "ArchiveRelease", "title": "ArchiveRelease", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "ExchangeVersion": { "__type_requested": "System.String", "required": true, "name": "ExchangeVersion", "title": "ExchangeVersion", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Initials": { "__type_requested": "System.String", "required": true, "name": "Initials", "title": "Initials", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Initials parameter specifies the user's initials." }, "MailboxProvisioningPreferences": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.MailboxProvisioningConstraint,", "required": true, "name": "MailboxProvisioningPreferences", "title": "MailboxProvisioningPreferences", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "UserPrincipalName": { "__type_requested": "System.String", "required": true, "name": "UserPrincipalName", "title": "UserPrincipalName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is available only in on-premises Exchange 2013.\nThe UserPrincipalName parameter specifies the UPN of the user." }, "WindowsLiveID": { "__type_requested": "System.String", "required": true, "name": "WindowsLiveID", "title": "WindowsLiveID", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "CertificateSubject": { "__type_requested": "MultiValuedProperty", "required": true, "name": "CertificateSubject", "title": "CertificateSubject", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "This parameter is available only in on-premises Exchange 2013.\nThe CertificateSubject parameter specifies the value of the subject field of the user's digital certificate." }, "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": true, "name": "Guid", "title": "Guid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RecipientType": { "__type_requested": "System.String", "required": true, "name": "RecipientType", "title": "RecipientType", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "AllowUMCallsFromNonUsers": { "__type_requested": "System.String", "required": true, "name": "AllowUMCallsFromNonUsers", "title": "AllowUMCallsFromNonUsers", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The AllowUMCallsFromNonUsers parameter specifies whether to exclude the user from directory searches." }, "DisplayName": { "__type_requested": "System.String", "required": true, "name": "DisplayName", "title": "DisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The DisplayName parameter specifies the user's display name." }, "OrganizationId": { "__type_requested": "System.String", "required": true, "name": "OrganizationId", "title": "OrganizationId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "UMCallingLineIds": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "UMCallingLineIds", "title": "UMCallingLineIds", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "This parameter is available only in on-premises Exchange 2013.\nThe UMCallingLineIds parameter specifies telephone numbers or extensions that can be mapped to a Unified Messaging (UM)-enabled user. You can specify more than one telephone number for each user, separated by a comma. This parameter accepts digits less than 128 characters in length and may include an optional plus sign (+) preceding the numbers. Each UM-enabled user must have a unique UMCallingLineIds parameter value." }, "ResetPasswordOnNextLogon": { "__type_requested": "System.Boolean", "required": true, "name": "ResetPasswordOnNextLogon", "title": "ResetPasswordOnNextLogon", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The ResetPasswordOnNextLogon parameter specifies whether the user's password must be reset the next time the user logs on. The two possible values for this parameter are $true or $false. The default value is $true." }, "SimpleDisplayName": { "__type_requested": "System.String", "required": true, "name": "SimpleDisplayName", "title": "SimpleDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The SimpleDisplayName parameter is used to display an alternative description of the object when only a limited set of characters is permitted. This limited set of characters consists of ASCII characters 26 through 126, inclusively." }, "LinkedMasterAccount": { "__type_requested": "System.String", "required": true, "name": "LinkedMasterAccount", "title": "LinkedMasterAccount", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is available only in on-premises Exchange 2013.\nThe LinkedMasterAccount parameter specifies the master account in the forest where the user account resides, if this user is a linked user. The master account is the account to which the user links. The master account grants access to the user. You can use one of the following values:\nGUID\nDN\nDomain\\Account\nUPN\nLegacyExchangeDN\nSmtpAddress\nAlias\n$null\nIf you set this parameter's value to $null, you will unlink the account and convert the linked mailbox into a non-linked user mailbox. The mailbox won't retain the permissions previously set on it such as Send As, full access, folder, and calendar delegation.\nThis parameter is required only if you're connecting a linked user." }, "WhenSoftDeleted": { "__type_requested": "", "required": true, "name": "WhenSoftDeleted", "title": "WhenSoftDeleted", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "RemotePowerShellEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "RemotePowerShellEnabled", "title": "RemotePowerShellEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "The RemotePowerShellEnabled parameter specifies whether the user can use remote PowerShell. remote PowerShell is required to open the Exchange Management Shell or the Exchange Administration Center. Access to remote PowerShell is required even if you're trying to open the Shell or the Exchange Administration Center on the local server.\nThe valid values are $true and $false. The default value depends on the management roles assigned to the user." }, "IsSecurityPrincipal": { "__type_requested": "System.Boolean", "required": true, "name": "IsSecurityPrincipal", "title": "IsSecurityPrincipal", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "DistinguishedName": { "__type_requested": "System.String", "required": true, "name": "DistinguishedName", "title": "DistinguishedName", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "UMDialPlan": { "__type_requested": "", "required": true, "name": "UMDialPlan", "title": "UMDialPlan", "__type_mapping_type": "Unknown", "readonly": true, "type": "string", "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string" }, "MicrosoftOnlineServicesID": { "__type_requested": "System.String", "required": true, "name": "MicrosoftOnlineServicesID", "title": "MicrosoftOnlineServicesID", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The MicrosoftOnlineServicesID parameter specifies the user ID for the object. This parameter only applies to objects in the cloud-based service. It isn't available for on-premises deployments." }, "SeniorityIndex": { "__type_requested": "Int32", "required": true, "name": "SeniorityIndex", "title": "SeniorityIndex", "__type_mapping_type": "Integer", "readonly": false, "type": "integer", "description": "The SeniorityIndex parameter specifies the order in which this user will display in a hierarchical address book. A user with a value of 2 will display higher in an address book than a user with a value of 1." }, "UpgradeDetails": { "__type_requested": "String", "required": true, "name": "UpgradeDetails", "title": "UpgradeDetails", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "UpgradeStageTimeStamp": { "__type_requested": "DateTime", "__type_mapping_type": "DateTime", "name": "UpgradeStageTimeStamp", "title": "UpgradeStageTimeStamp", "format": "date-time", "required": true, "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "SamAccountName": { "__type_requested": "System.String", "required": true, "name": "SamAccountName", "title": "SamAccountName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is available only in on-premises Exchange 2013.\nThe SamAccountName parameter specifies the logon name used to support clients and servers running older versions of the operating system, such as Microsoft Windows NT 4.0, Windows 98, Windows 95, and LAN Manager. This attribute must contain fewer than 20 characters." }, "ObjectCategory": { "__type_requested": "System.String", "required": true, "name": "ObjectCategory", "title": "ObjectCategory", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "RecipientTypeDetails": { "__type_requested": "System.String", "required": true, "name": "RecipientTypeDetails", "title": "RecipientTypeDetails", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The RecipientTypeDetails parameter specifies the type of recipients returned. Recipient types are divided into types and subtypes. Each recipient type contains all common properties for all subtypes. For example, the type UserMailbox represents a user account in Active Directory that has an associated mailbox. Because there are several mailbox types, each mailbox type is identified by the RecipientTypeDetails parameter. For example, a conference room mailbox has RecipientTypeDetails set to RoomMailbox, whereas a user mailbox has RecipientTypeDetails set to UserMailbox.\nYou can use the following values:\nDisabledUser\nDiscoveryMailbox\nEquipmentMailbox\nLegacyMailbox\nLinkedMailbox\nLinkedUser\nMailUser\nRemoteEquipmentMailbox\nRemoteRoomMailbox\nRemoteSharedMailbox\nRemoteTeamMailbox\nRemoteUserMailbox\nRoomMailbox\nSharedMailbox\nTeamMailbox\nUser\nUserMailbox" }, "IsValid": { "__type_requested": "System.Boolean", "required": true, "name": "IsValid", "title": "IsValid", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "WhenChanged": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChanged", "title": "WhenChanged", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "DirectReports": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.Directory.ADMultiValuedProperty`1[[Microsoft.Exchange.Data.Directory.ADObjectId,", "required": true, "name": "DirectReports", "title": "DirectReports", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "ObjectState": { "__type_requested": "System.String", "required": true, "name": "ObjectState", "title": "ObjectState", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "UpgradeMessage": { "__type_requested": "String", "required": true, "name": "UpgradeMessage", "title": "UpgradeMessage", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "StateOrProvince": { "__type_requested": "System.String", "required": true, "name": "StateOrProvince", "title": "StateOrProvince", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The StateOrProvince parameter specifies the user's state or province." }, "LEOEnabled": { "__type_requested": "System.Boolean", "required": true, "name": "LEOEnabled", "title": "LEOEnabled", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "FirstName": { "__type_requested": "System.String", "required": true, "name": "FirstName", "title": "FirstName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The FirstName parameter specifies the user's given name." }, "NetID": { "__type_requested": "NetID", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "NetID", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "NetID" }, "MailboxRelease": { "__type_requested": "System.String", "required": true, "name": "MailboxRelease", "title": "MailboxRelease", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "PhoneticDisplayName": { "__type_requested": "System.String", "required": true, "name": "PhoneticDisplayName", "title": "PhoneticDisplayName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PhoneticDisplayName parameter specifies a phonetic pronunciation of the DisplayName parameter.\nThe maximum length of this parameter value is 255 characters." }, "SKUAssigned": { "__type_requested": "$true | $false", "required": true, "name": "SKUAssigned", "title": "SKUAssigned", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean", "description": "This parameter is reserved for internal Microsoft use." }, "ConsumerNetID": { "__type_requested": "NetID", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "ConsumerNetID", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "ConsumerNetID" }, "PSComputerName": { "__type_requested": "System.String", "required": false, "name": "PSComputerName", "title": "PSComputerName", "__type_mapping_type": "String", "readonly": true, "type": "string" }, "AssistantName": { "__type_requested": "System.String", "required": true, "name": "AssistantName", "title": "AssistantName", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The AssistantName parameter specifies the name of the user's assistant." }, "Phone": { "__type_requested": "System.String", "required": true, "name": "Phone", "title": "Phone", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Phone parameter specifies the user's office telephone number." }, "Identity": { "__type_requested": "System.String", "required": true, "name": "Identity", "title": "Identity", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Identity parameter specifies the identity of the user object.\nThis parameter accepts the following values:\nExample: JPhillips\nExample: Atlanta.Corp.Contoso.Com/Users/JPhillips\nExample: Jeff Phillips\nExample: CN=JPhillips,CN=Users,DC=Atlanta,DC=Corp,DC=contoso,DC=com\nExample: Atlanta\\JPhillips\nExample: fb456636-fe7d-4d58-9d15-5af57d0354c2\nExample: [email protected]\nExample: /o=Contoso/ou=AdministrativeGroup/cn=Recipients/cn=JPhillips\nExample: [email protected]\nExample: [email protected]" }, "UserAccountControl": { "__type_requested": "System.String", "required": true, "name": "UserAccountControl", "title": "UserAccountControl", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "PostalCode": { "__type_requested": "System.String", "required": true, "name": "PostalCode", "title": "PostalCode", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The PostalCode parameter specifies the user's zip code or postal code." }, "ExternalDirectoryObjectId": { "__type_requested": "System.String", "required": true, "name": "ExternalDirectoryObjectId", "title": "ExternalDirectoryObjectId", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "Office": { "__type_requested": "System.String", "required": true, "name": "Office", "title": "Office", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Office parameter specifies the user's physical office name or number." }, "PreviousRecipientTypeDetails": { "__type_requested": "System.String", "required": true, "name": "PreviousRecipientTypeDetails", "title": "PreviousRecipientTypeDetails", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "UpgradeStatus": { "__type_requested": "System.String", "required": true, "name": "UpgradeStatus", "title": "UpgradeStatus", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "This parameter is reserved for internal Microsoft use." }, "WhenChangedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenChangedUTC", "title": "WhenChangedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "City": { "__type_requested": "System.String", "required": true, "name": "City", "title": "City", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The City parameter specifies the user's city." }, "WhenCreatedUTC": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreatedUTC", "title": "WhenCreatedUTC", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "UpgradeStage": { "__type_requested": "None | SyncedWorkItem | StartPilotUpgrade | StartOrgUpgrade | MoveArbitration | MoveRegularUser | MoveCloudOnlyArchive | MoveRegularPilot | MoveCloudOnlyArchivePilot | CompleteOrgUpgrade", "required": true, "description": "This parameter is reserved for internal Microsoft use.", "title": "UpgradeStage", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "UpgradeStage" }, "Sid": { "__type_requested": "System.String", "required": true, "name": "Sid", "title": "Sid", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "UMDtmfMap": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "UMDtmfMap", "title": "UMDtmfMap", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The UMDtmfMap parameter specifies whether you want to create a user-defined DTMF map for the UM-enabled user." }, "ObjectClass": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "ObjectClass", "title": "ObjectClass", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array" }, "Pager": { "__type_requested": "System.String", "required": true, "name": "Pager", "title": "Pager", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Pager parameter specifies the user's pager number." }, "IsSoftDeletedByDisable": { "__type_requested": "System.Boolean", "required": true, "name": "IsSoftDeletedByDisable", "title": "IsSoftDeletedByDisable", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "PostOfficeBox": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "PostOfficeBox", "title": "PostOfficeBox", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The PostOfficeBox parameter specifies the user's post office box number." }, "IsLinked": { "__type_requested": "System.Boolean", "required": true, "name": "IsLinked", "title": "IsLinked", "__type_mapping_type": "Boolean", "readonly": false, "type": "boolean" }, "Name": { "__type_requested": "System.String", "required": true, "name": "Name", "title": "Name", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The Name parameter specifies the user's common name." }, "Manager": { "__type_requested": "UserContactIdParameter", "required": true, "description": "The Manager parameter specifies the user's manager.", "title": "Manager", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "Manager" }, "WhenCreated": { "__type_requested": "System.DateTime", "__type_mapping_type": "DateTime", "name": "WhenCreated", "title": "WhenCreated", "format": "date-time", "required": true, "readonly": false, "type": "string" }, "OrganizationalUnit": { "__type_requested": "System.String", "required": true, "name": "OrganizationalUnit", "title": "OrganizationalUnit", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The OrganizationalUnit parameterreturns objects only from the specified organizational unit (OU)." }, "OtherFax": { "__type_requested": "Deserialized.Microsoft.Exchange.Data.MultiValuedProperty`1[[System.String,", "required": true, "name": "OtherFax", "title": "OtherFax", "items": { "type": "string" }, "__type_mapping_type": "String[]", "readonly": false, "type": "array", "description": "The OtherFax parameter specifies the user's alternative fax number." }, "CountryOrRegion": { "__type_requested": "CountryInfo", "required": true, "description": "The CountryOrRegion parameter specifies the user's country or region.", "title": "CountryOrRegion", "__type_mapping_type": "Unknown", "readonly": true, "__WARNING": "Unhandled and unknown upstream type, this attribute forced into a readonly string", "type": "string", "name": "CountryOrRegion" }, "Id": { "__type_requested": "System.String", "required": true, "name": "Id", "title": "Id", "__type_mapping_type": "String", "readonly": false, "type": "string" }, "HomePhone": { "__type_requested": "System.String", "required": true, "name": "HomePhone", "title": "HomePhone", "__type_mapping_type": "String", "readonly": false, "type": "string", "description": "The HomePhone parameter specifies the user's home telephone number." } }, "schema_version": "15312" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/exchangehybrid/User/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/exchangehybrid/User/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/exchangehybrid/User/[pkid1]", "/api/v0/device/exchangehybrid/User/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/exchangehybrid/User/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/User |
|
{"hrefs": ["/api/device/exchangehybrid/User/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/exchangehybrid/User |
|
{"hrefs": ["/api/device/exchangehybrid/User/[pkid1]", "/api/device/exchangehybrid/User/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/exchangehybrid/User; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/exchangehybrid/User/export/ |
|
{ "hrefs":["/api/device/exchangehybrid/User/[pkid1]", "/api/device/exchangehybrid/User/[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/exchangehybrid/User and the JSON format can be used to import instances of device/exchangehybrid/User.
GET http://[host-proxy]/api/device/exchangehybrid/User/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/exchangehybrid/User | POST | /api/device/exchangehybrid/User/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/exchangehybrid/User/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/exchangehybrid/User/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/exchangehybrid/User/ |
|
The device/exchangehybrid/User schema and all instances as JSON. |
(The list will return 0 to 3 device/exchangehybrid/User instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/exchangehybrid/User/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "15312", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/exchangehybrid/User/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/exchangehybrid/User", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/exchangehybrid/User/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/exchangehybrid/User/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/exchangehybrid/User/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/exchangehybrid/User/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/exchangehybrid/User/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/exchangehybrid/User/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/exchangehybrid/User/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/exchangehybrid/User", "model_specific_actions": [ "get", "list", "update", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "DisplayName" }, { "name": "Name", "title": "Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/exchangehybrid/User. | GET | /api/device/exchangehybrid/User/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/exchangehybrid/User as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/exchangehybrid/User/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/exchangehybrid/User/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/exchangehybrid/User/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/exchangehybrid/User | 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/exchangehybrid/User; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/exchangehybrid/User/[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/exchangehybrid/User and the JSON format can be used to import instances of device/exchangehybrid/User.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/exchangehybrid/User/[pkid] | hierarchy=[hierarchy] | The device/exchangehybrid/User instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/exchangehybrid/User/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/exchangehybrid/User. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/exchangehybrid/User/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |