[Index]

API Reference for view/Exchange_online_MoveRequest_view

. Exchange Mailbox and Unified Messaging Bulk Migration Tool ========================================================== This tool is used to move Mailboxes in Exchange from Microsoft Exchange Server to Microsoft Exchange Online or vice versa. Select the menu option **Bulk Migration Tools > Exchange > Migrate Mailboxes**. Select one of the following Migrate Actions: * Online to On-Prem * On-Prem to Online When the selected Migration Action changes, the users available to be moved is populated as follows: * When the "Online to On-Prem" migrate action is selected, the list of users shows current Exchange Online users (with Exhange Hybid Remote Mailboxes) in the selected hierarchy. * When the "On-Prem to Online" migrate action is selected, the list of users shows current Exchange Mailbox users in the selected hierarchy. The Quick Add Group is used to specify the details of the services activated for the user. The details of the Mailbox and the Unified Messaging Account specified in the templates of the Quick Add Groups is used to update the target Mailbox and UM Mailbox. Logic for determining the Licenses and Service Plans assigned to the user: * **On-prem to online**: The user's existing licenses and enabled service plans are merged with the service plans specified under Exchange in the Quick Add Group selected. * **Online to on-prem**: Service plans related to Exchange Online are removed from the user's existing licenses if present. Quick Add Groups are not taken into account. The RemoteHostName parameter specifies the FQDN of the cross-forest organization from which you're moving the mailbox. The TargetDeliveryDomain parameter specifies the FQDN of the external email address created in the source forest for the mail-enabled user when the move request is complete. This parameter is applicable when performing remote moves with the Remote or RemoteLegacy parameter. When Migrating the User from Microsoft Exchange Online to Microsoft Exchange then the Remote Target Database can be specified. If it is not specified the default value will be derived from the Microsoft Site Defaults. During Quick Add Subscriber operations, the value for the following settings are derived from the VOSS Microsoft Default settings for each site: * Remote Host Name * Target Delivery Domain * Remote Target Database The users that need to be moved can be specified by selecting a list of users (identified by UserPrincipalName) to move. **NOTE**: In order for the the migration to be completed the Multi-stage provisioning workflow needs to be executed to process users in each of the steps in the workflow. The amount of time and frequency with with the multi-stage provisioning workflow needs to be executed is dependant on the size of the migration, the types of licenses used for each user group, the amount of Microsoft Skype Front End Pools, Exchange On-Prem servers and connections to Microsoft Online. Refer to the best practices recommended by VOSS Global Services. Mailbox Migration Workflow -------------------------- There are two types of Migration Workflows supported: * On-prem to Online * Online to On-prem The workflows supports the following steps: * **On-prem to online**: * Move the Mailbox from on-prem to online. * Determine the licenses/service plans to be assigned to the user from the Quick Add Group and existing licenses/service plans of the user. * Update the user's licenses in Microsoft Online portal. * Completion of replication the users' details from Azure AD (i.e. “Get-MsolUser”) to Exchange Online Global Address List (GAL) (i.e. “Get-Recipient”). Replication (forward sync completion) is verified by ensuring that CloudExchangeRecipientDisplayType is not NULL. * Update the user's properties/policies based on the selected quick add group (To be completed). * Delete the Mailbox Move Request. * **Online to on-prem**: * Move the Mailbox from online to on-prem. * Determine the licenses/service plans to be assigned to the user by subtracting service plans related to Exchange Online from the user's existing licenses if present. * Update the user's licenses in Microsoft Online portal. * Delete the Mailbox Move Request. On-Prem to Online Migrations ---------------------------- Migrations involving On-Prem to Online Provisioning is completed in 3 stages: * Stage 1: Provision On-Prem services: * Add Exchange Mailbox * Enable Mailbox for Unified Messaging (UM) * Stage 2: Provision Online services: * Wait for AD FS Dir Sync to sync AD users to MS Online * Sync in MS Online User and move them to the correct site in VOSS Automate * Wait for "forward sync" process to complete. * Move Mailbox Online * Stage 3: Complete the Mailbox Move Request: * Wait for Mailbox Move Request to complete * License User for Exchange Service Plans * According to MS Online Service Plans in QAG * Delete Mailbox Move Request * Update user online mailbox and UM settings according to QAG The Quick Add Subscriber Operation or a Bulk On-Prem to Online Migration Action trigger stage 1. Stage 2 and 3 is completed by executing the scheduled task "MultiStageMSOnlineProvisioning_Schedule". Online to On-Prem Migrations ---------------------------- Migrations involving Online to On-Prem Provisioning is completed in 2 stages: * Stage 1: * Move Mailbox On-Prem * Stage 2: Complete the Mailbox Move Request: * Wait for Mailbox Move Request to complete * De-license User for Exchange Service Plans * Delete Mailbox Move Request * Update user on-prem mailbox and UM settings according to QAG A Bulk Online to On-Prem Migration Action trigger stage 1. Stage 2 is completed by executing the scheduled task "MultiStageMSOnlineProvisioning_Schedule". .. |VOSS-4-UC| replace:: VOSS-4-UC

Model ref.: view/Exchange_online_MoveRequest_view

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/view/Exchange_online_MoveRequest_view/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of view/Exchange_online_MoveRequest_view 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.

Create

Task Call URL Parameters Payload
Create POST /api/view/Exchange_online_MoveRequest_view/ hierarchy=[hierarchy]
(For payload specification)

  • Response is a transaction pkid for the create action.
  • The GET call to
    tool/Transaction/[trans pkid]
    shows the View resource has no instance pkid, because a view model stores no instances.
  • Export Bulk Load Template

    Task Call URL Parameters Response
    Get a compressed format of the Bulk Load spreadsheet template for view/Exchange_online_MoveRequest_view POST /api/view/Exchange_online_MoveRequest_view/export_bulkload_template/
    • hierarchy=[hierarchy]
    • modeltype=view/Exchange_online_MoveRequest_view
    The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/view/Exchange_online_MoveRequest_view/configuration_template/ hierarchy=[hierarchy]
    • POST call to create the Configuration Template
    • Configuration Template schema

    • Use the returned properties to create the POST payload data for the .
    • For a description of the schema that shows properties to add to the POST payload:
      • The POST call is of the format:
      • POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

    Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/view/Exchange_online_MoveRequest_view/field_display_policy/ hierarchy=[hierarchy]
    • POST call to create the Field Display Policy
    • Field Display Policy schema

    • Use the returned properties to create the POST payload data for the .
    • For a description of the schema that shows properties to add to the POST payload:
    • The POST call is of the format:
      • POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

    List

    Task Call URL Parameters Response
    List GET /api/view/Exchange_online_MoveRequest_view/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    The view/Exchange_online_MoveRequest_view schema and all instances as JSON.

    (The list will return 0 to 3 view/Exchange_online_MoveRequest_view instances)

    Help

    Task Call URL Parameters Response
    Get the on-line Help for view/Exchange_online_MoveRequest_view. GET /api/view/Exchange_online_MoveRequest_view/help hierarchy=[hierarchy] On-line help of Model ref.: view/Exchange_online_MoveRequest_view as HTML

    Instance API Reference

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/view/Exchange_online_MoveRequest_view/[pkid]/clone/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    A JSON payload with:
    • A POST action URL.
    • The unchanged model [pkid] payload to be modified to create a new instance.
    • For the instance pkids that can cloned, refer to the List GET call for view/Exchange_online_MoveRequest_view
    • GET http://[host-proxy]/api/view/Exchange_online_MoveRequest_view/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Tag

    Task Call URL Parameters Payload
    Tag PATCH /api/view/Exchange_online_MoveRequest_view/[pkid]/+tag/ hierarchy=[hierarchy] If payload required:

    Get

    Task Call URL Parameters Response
    Get GET /api/view/Exchange_online_MoveRequest_view/[pkid]/ hierarchy=[hierarchy] The view/Exchange_online_MoveRequest_view instance with [pkid].

    Help

    Task Call URL Parameters Response
    Help GET /api/view/Exchange_online_MoveRequest_view/[pkid]/help hierarchy=[hierarchy] The on-line Help for view/Exchange_online_MoveRequest_view.