REST API Reference

Back Next

connectionMigration

Use this resource to migrate an old version of the connection in referenced assets to the latest connection version within an organization. The migration creates a copy of the project folder and assets and updates the referenced connection in the assets with the latest version.

You can migrate old connections used in Source, Target, and Lookup transformations from assets such as mappings and tasks. If the connection is used across assets in multiple projects, all the referenced assets are updated to use the current connection version.

POST request

To specify the connections to migrate and start the migrate job, use the following URI:

saas/api/v2/connectionMigration/migrate

Include the following fields in the request:

Field	Type	Required	Description
icSessionId	String	Yes	Informatica Intelligent Cloud Services session ID.
sourceConn	String	Yes	The name of the source connection that you want to migrate. This is the old version of the connector.
targetConn	String	Yes	The target connection name to which you want to migrate. This is the current version of the connector.
projectName	String	No	The project name contains the referenced assets of the source connection that you want to migrate. If you do not specify the project name, the source connection in all assets are migrated.

POST request example

You can use a request similar to the following example:

POST <baseURL>/saas/api/v2/connectionMigration/migrate
Content-Type: application/json
Accept: application/json
icSessionId: <sessionId>

{
  "sourceConn": "Migration_V1",
  "targetConn": "Migration_V2",
  "projectName": "V1_Assets"
}

POST response

If successful, returns the following information for the export job:

Field	Type	Description
id	String	Global unique identifier for the migration job.
name	String	Name of the migration job.
count	Integer	Number of dependent objects.
status	Complex type	Status of the migration.
objects	Collection	Objects in the migration job.
name	String	Returned in the objects object. Name of the asset that uses the connector.
type	String	Returned in the objects object. The type of asset.
sourcePath	String	Returned in the objects object. Complete path of the referenced asset in the old connection.
targetPath	String	Returned in the objects object. Complete path of the referenced assets in the current connection. The target folder uses the same name as the source folder, with "_Migration_<migration job ID>" appended to the name for identification.
status	String	Returned in the objects object. State of the connection updated in the asset, such as IN PROGRESS, SUCCESS, or FAILED.

POST response examples

If successful, you might receive a response similar to the following example:

{
    "id": "4l1XcURpYFjjxpopb7AJ0L",
    "name": "job-1661702962208",
    "count": "1",
    "status": "SUCCESSFUL",
    "objects": [
        {
            "name": "Mapping_V1",
            "type": "DTEMPLATE",
            "sourcePath": "/AA_Migration_Doc",
            "targetPath": "/AA_Migration_Doc_Migration_4l1XcURpYFjjxpopb7AJ0L",
            "status": "SUCCESSFUL"
        }
    ]
}

If you receive an error, you might see a response similar to the following example:

{
  "error": {
    "code": "MigrationSvc_034",
    "message": "Invalid object id/s [[242973wgfscbwasd23]]. Object resolution failed.",
    "requestId": "2ataXVlgw3ydI1Yb2MA4sq"
  }
}

For more information about using the connectionMigration resource to migrate the connectors to the latest version and for the list of connectors that support migration, see the following How-To Library article: Migrating a connector from previous versions using the Data Integration REST API

Data Integration REST API

Download Guide

Watch

Comments

Cloud Data Integration Homepage