Deprecation notice for the existing migration model retrieving migration details with containers

From 17 April 2021, the app migration platform will no longer support the existing migration model of retrieving details of migrations with containers (space and project keys).

Existing behavior

Currently, you can retrieve details of migrations with containers (space, project and site) in the following ways:

• For the server app:
  Implement the onStartAppMigration method to either of the following app migration listeners:

  • AppCloudMigrationListener::onStartAppMigration, OR
  • CloudMigrationListener::onStartAppMigration

• For the cloud app:

  • Make the following request: GET /migration/
  • Use the LISTENER_TRIGGERED and APP_DATA_UPLOADED events payload

Replacement

In order to retrieve migration details, you will need to use the new migration model EnrichedMigrationDetailsDtoV1 without the containers and creator fields.

• For the server app:

  • Implement the onStartAppMigration method of interface AppCloudMigrationListenerV1 to receive the migration details in the new model. See an example here.
  • Use the new API in AppCloudMigrationGateway to retrieve containers (Confluence Spaces, Jira Projects etc.) associated with a migration in a paginated form. See an example here.

• For the cloud app:

  • Register webhooks with an additional query parameter version=1 to receive LISTENER_TRIGGERED and APP_DATA_UPLOADED events with the new migration model. See an example.
  • Use the new Transfer retrieval API to do the following:

    • Fetch details about the last 100 active app migration transfers with migration details in the new migration model.
      Use the following method and endpoint to retreive a list of active transfers (upto 100 transfers) with migration details available for your cloudAppKey:
      

      Method	Endpoint
      GET	/migration/transfer/recent

    • Get a list of all containers (Confluence Spaces, Jira Projects etc.) associated with the migration
      Use the following method and endpoint to get a list of all containers for a given containerType in a paginated form (upto 250 containers):
      

      Method	Endpoint
      GET	/migraton/container/{transferId}/page

Reason for change

This change will bring in better performance and improved scaling for the app migration platform.