Migrating an API Service Using Git

Overview

The API Service Migration feature allows users to import previously exported API Services across different users, workspaces, or servers. This ensures seamless transfer of published API Services while maintaining data connectors, categories, and template JSON configurations

Note: Only published/exported API Services are available for migration. The Version Control configuration must be identical across the source and target environments.

Pre-requisites

1. Complete the DS Lab Migration configuration via the Admin module, including Version Control, Execution, and DS Lab settings.

2. Ensure the API Service is already exported/published to Git.

3. Both source and target environments must have compatible Version Control settings.

Steps to Import an API Service

Navigation path: Admin Module > Git Migration > Import File > Import Document > Migration – Document Import

1. Navigate to the Admin Module.

2. Click the Git Migration icon from the side navigation bar.

3. Click Import File.

4. On the next page, click Import.

5. The Migration – Document Import screen opens.

6. Select New VCS for the Version Control Configuration.

7. From the Select a Module drop-down menu (top-right corner), select API Service.

8. A list of available published API Services appears on the left.

9. Use the Search bar to locate a specific API Service.

10. Click an API Service from the list to open its details.

11. All available versions of the selected API Service appear.

12. Select the desired version using the checkbox.

The following information is displayed for the selected API Service:

• Data Source Names

• Dataset Names

• API Service Name

• Category Name

1. Click Migrate to proceed.

Configuring the Data Connector

During migration, the Data Connector Details dialog box appears. Users have two options:

1. Use Existing Connector

1. Select Use an Existing Connector.

2. Choose a data connector from the drop-down menu.

3. Click Save to apply the configuration.

2. Create a New Data Connector

1. Select Create a New Connector.

2. Provide the required details:

   • Username

   • Password

   • PI/Host

   • Database Name

3. Click Save to persist the new connector configuration.

Note:

• Users can select Skip if migrating a version of an API Service that has already been configured.

• It is mandatory to provide connector details when migrating the API Service for the first time.

Accessing the Migrated API Service

1. Navigate to the Data Center module.

2. Open the Standard Connectors list.

3. The corresponding data connector for the migrated API Service is added to the top of the list.

4. Open the Data as API tab for the data connector.

5. The imported Data as API is listed under this tab and ready for use.

Notes

• API Services can be migrated across users, spaces, or servers, provided the Version Control settings are consistent.

• The migrated API Service retains the same category and Template JSON as the source.

• Only published/exported API Services are visible for migration.