Data Map lets you search for and inspect any DataService Studio API across all workspaces in your tenant — from basic metadata to parameters, sample responses, data lineage, and usage notes.
To edit an API from its details page, your account must be a member of the workspace that owns the API and have the developer role. If not, contact the workspace administrator. For details, see Manage permissions on workspace-level services.
Open Data Map
-
Log on to the DataWorks console.
-
In the top navigation bar, select your region.
-
In the left-side navigation pane, choose Data Governance > Data Map.
-
On the page that appears, click Go to Data Map.
-
On the Data Map homepage, select API from the Type drop-down list below the search box.
Search for an API
Data Map searches across the following fields:
| Searchable field | Example |
|---|---|
| API ID | A numeric identifier |
| API path | The URL path of the API endpoint |
| API name | The display name of the API |
| API description | Keywords from the description text |
To search for an API:
-
Enter a keyword in the search box. The first 10 matching APIs appear in the drop-down list as preliminary results.
-
If the API you need is not in the drop-down list, click Search. All APIs that match the keyword are displayed.
-
To narrow the results, use the filters on the left: API Type, Workspace, and Owner.
-
Click an API name to open its details page.
View API details
The API details page is divided into three areas.
Area 1 — Edit access
Click Edit API to open the API's configuration tab in its workspace and edit it. For more information, see Publish an API and Register an API.
Area 2 — Basic and technical information
| Section | Fields |
|---|---|
| Basic information | View count, call count, API ID, workspace, API owner, creation time, update time, API description |
| Technical information | API type, request method, return type, data source type, data source name, table name |
Area 3 — Parameters, sample response, lineage, and usage notes
Parameter information
The Parameter Information tab has two subtabs:
-
Request Parameters — Lists common and application request parameters, including parameter name, parameter type, parameter location, sample value, default value, description, and tag.
-
Response Parameters — Lists common and application response parameters, including parameter name, parameter type, sample value, and description.
Sample response
Displays the result structure returned by an API request. The sample response is updated automatically when you select Save the correct response example automatically during testing before publishing. For more information, see Test an API.
Lineage
Shows the complete data lineage across tables, APIs, and applications.
Supported ancestor data sources: Hologres, MySQL, PostgreSQL, SQL Server, Oracle, AnalyticDB for MySQL 3.0, and AnalyticDB for PostgreSQL.
| API type | Lineage scope |
|---|---|
| Generated API | Data tables → API → applications |
| Registered API | API → applications only |
Lineage information is generated and updated with a delay of one day.
Usage notes
Click Edit to update the usage notes for the API, or click View Versions to browse the version history.