API Query

Note

The Data Productivity Cloud API Query solution will only be available if you're using version 10.1232.0 of the agent (or higher). To understand agent versioning in the Data Productivity Cloud, read Agent version tracks.

When you migrate a job that includes an API Query component, the API Query Profile used by that component isn't automatically migrated with it. If you examine the migrated pipeline in the Data Productivity Cloud, you will see that the API Query component is present but fails to validate. The migration report will show that the query profile (called the configuration file in the Data Productivity Cloud) is missing.

Note

If your job uses the API Extract component, read API Extract instead.

---

Migration path

The API Query component will be migrated automatically. However, you need to manually export the API Query profile from Matillion ETL and import it into the Data Productivity Cloud. After you have imported the profile, the API Query component in your pipeline should validate.

To migrate the query profile:

1. In Matillion ETL, click Project → Manage API Profiles → Manage Query Profiles.

2. In the Manage Query Profiles dialog, locate the profile you want to export and click the download icon next to it. This will download the profile as a .json file to your local filesystem (exact location will depend on your browser and operating system).

   Note

   If you have multiple profiles that you need to download, you may wish to use the Matillion ETL API to download multiple profiles to a single .json file in a single operation.

3. Open your Data Productivity Cloud project and branch.

4. In the Files panel, click the three dots ... next to the folder you want to import to, or click Add at the top, then click Import from the drop-down.

5. In the file navigator, browse to the .json file you exported from Matillion ETL and click Open.

   Note

   This file can contain multiple API Query profiles if you exported them using the Matillion ETL API. In this case, every profile in the file will be imported.

6. In the Importing files panel, click the API query profiles tab and check that the expected profiles are listed. The detailed import report should also list all of the imported data sources.

7. After the import is complete, you will see the imported profiles in the Files panel, and the API Query component in your pipeline should now validate.