Exporting All/Exporting/Importing APIs

Operation Scenario

DataArts DataService allows you to import and export (including exporting all) APIs to quickly copy or migrate existing APIs.

Constraints

• To export all APIs, you must have the permissions of the DAYU Administrator or Tenant Administrator.
• All the APIs of a workspace can be exported only once, and only one such export task can be executed within a minute.

Exporting All APIs

You can export all APIs based on the current filter criteria. You must have the permissions of the DAYU Administrator or Tenant Administrator.

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
   Figure 1 DataArts DataService
   

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Development > APIs.
4. Above the API list, choose More > Export All.
   

   • To export all APIs, you must have the permissions of the DAYU Administrator or Tenant Administrator.
   • All the APIs of a workspace can be exported only once, and only one such export task can be executed within a minute.

   In the displayed dialog box, click Yes to export all the APIs to an Excel file.

   Figure 2 Exporting all APIs
   
5. Open the downloaded Excel file to view the exported APIs. APIs of different types are exported to different sheets.
   Figure 3 Exported Excel file
   

Exporting APIs

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
   Figure 4 DataArts DataService
   

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Development > APIs.
4. Select the target APIs, click More above the API list, and select Export.
5. In the displayed dialog box, confirm the APIs to export and click Yes to export the APIs to an Excel file.
   Figure 5 Exporting APIs
   
6. Open the downloaded Excel file to view the exported APIs. APIs of different types are exported to different sheets.
   Figure 6 Exported Excel file
   

Importing APIs

1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
   Figure 7 DataArts DataService
   

2. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
3. Choose API Development > APIs.
4. Click More above the API list and select Import.
5. On the displayed page, click Select, select an API file, and click Import. The import status is displayed in the Import Result area.
   

   The API file can be one exported from another project or an Excel file edited based on the template specifications.

   Figure 8 Importing APIs
   
6. After the APIs are imported successfully, you can view them in the API list.