[Index]

API Reference for view/Move_CsUser_view

. Skype for Business User Bulk Migration Tool =========================================== This tool is used to move CsUsers in Skype for Business from Microsoft Skype for Business Server to Microsoft Skype for Business online or vice versa. Select the menu option **Bulk Migration Tools > Skype for Business > Migrate Users**. Select one of the following Migrate Actions: * Online to On-Prem * On-Prem to Online The users that need to be moved can be specified by selecting a list of users (by UserPrincipalName) to move. 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 Skype for Business Online users in the selected hierarchy. * When the "On-Prem to Online" migrate action is selected, the list of users shows current Skype for Business users in the selected hierarchy. The following settings are derived from the Microsoft Defaults of the VOSS site the user is allocated to: * The Hosted Migration Override URL is the URL for the hosted migration service used when moving a user to Skype for Business Online. * The Target is the FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the user account should be moved. In addition to a Registrar pool, the Target can also be the FQDN of a legacy Office Communications Server Front End Server or a hosting provider. Any accounts moved to a hosting provider will lose all their associated user data. For example, any conferences the user has scheduled will be deleted and will not be available in Skype for Business Online. The Quick Add Group is used to specify the details of the services activated for the user. 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 Skype for Business in the Quick Add Group selected. * **Online to on-prem**: Service plans related to Skype for Business online are subtracted from the user's existing licenses if present. Quick Add Groups are not taken into account. **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. User Migration Workflow ----------------------- The workflow supports the following steps: * **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. * Wait for the user's license provisioning to completed. * Move the user from on-prem to online. * **Online to on-prem**: * Move the user from online to on-prem. * Determine the licenses/service plans to be assigned to the user by subtracting service plans related to Skype for Business online from the user's existing licenses if present. * Update the user's licenses in Microsoft Online portal. .. |VOSS-4-UC| replace:: VOSS-4-UC

Model ref.: view/Move_CsUser_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/Move_CsUser_view/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of view/Move_CsUser_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/Move_CsUser_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/Move_CsUser_view POST /api/view/Move_CsUser_view/export_bulkload_template/
    • hierarchy=[hierarchy]
    • modeltype=view/Move_CsUser_view
    		 The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

    Tag

    Task Call URL Parameters Response
    Tag PATCH /api/view/Move_CsUser_view/+tag/
    • hierarchy=[hierarchy]
    • format=json
    		  

    Tag Version

    Task Call URL Parameters Response
    Tag Version PATCH /api/view/Move_CsUser_view/+tag_version/
    • hierarchy=[hierarchy]
    • format=json
    		  

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/view/Move_CsUser_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/Move_CsUser_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/Move_CsUser_view/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    		 The view/Move_CsUser_view schema and all instances as JSON.

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

    Help

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

    Transform Template

    Task Call URL Parameters Response
    Transform Template GET /api/view/Move_CsUser_view/transform/
    • hierarchy=[hierarchy]
    • format=json
    		  

    Instance API Reference

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/view/Move_CsUser_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/Move_CsUser_view
    • GET http://[host-proxy]/api/view/Move_CsUser_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/Move_CsUser_view/[pkid]/+tag hierarchy=[hierarchy] If payload required:

    Get

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

    Help

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