Help Center/ DataArts Studio/ User Guide/ DataArts DataService/ API Development/ Managing APIs/ Setting an API to Be Visible
Updated on 2022-09-23 GMT+08:00
View PDF

Setting an API to Be Visible

Scenario

If you want to change the visibility scope of an API in the service catalog, you can use the Display function or set the Display Scope parameter for the API.

Prerequisites

An API has been created.

Changing the API Visibility Scope Using the Display Function

  1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
  2. Choose API Development > API Catalogs or API Development > APIs. Locate an API, click More in the Operation column, and select Display.
  3. In the displayed dialog box, click Add, enter a project ID, and click OK to make the API visible to users in the project.

    For how to obtain the project ID, see (Optional) Obtaining Authentication Information.

    Figure 1 Display API

Changing the API Visibility Scope by Setting the Display Scope Parameter

  1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
  2. Choose API Development > API Catalogs or API Development > APIs. Locate an API and click Edit in the Operation column. An API can be edited only when it is in the Created, Rejected, Offline, or Disabled state.
  3. On the Configure Basic Details page, select a value for the Display Scope parameter. The value can be Current workspace's APIs, Current project's APIs, or Current tenant's APIs. Then save the modification.
  4. Restore or publish the API again to change the visibility scope of the API in the service catalog.
Parent topic: Managing APIs