Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts Architecture API Overview

Updated on 2025-11-17 GMT+08:00

View PDF

DataArts Architecture API Overview

**Table 1** DataArts Architecture API types
Type	Description
Dashboard	Dashboard APIs
Information Architecture	Information architecture APIs
Data Standard	Data standard APIs
Data Source	Data source APIs
Lookup Table Management	Lookup table management APIs
Catalog	Catalog APIs
Data Standard Template	Data standard template APIs
Approval Management	Approval management APIs
Subject Management	Subject management APIs
Subject Level	Subject level APIs
Catalog Management	APIs for managing the catalogs of lookup tables and data standards
Atomic Metric	Atomic metric APIs
Derivative Metric	Derivative metric APIs
Compound Metric	Compound metric APIs
Dimension	Dimension APIs
Filter	Filter APIs, including those for time filters and general filters
Dimension Table	Dimension table APIs
Fact Table	Fact table APIs
Summary Table	Summary table APIs
Business Metric	Business metric APIs
Version Information	Version information APIs
ER Modeling	Table model APIs
Import/Export	Import and export APIs
Custom Item	Custom item APIs
Tag	Tag APIs
Quality Rule	Quality rule APIs

Dashboard

**Table 2** Dashboard
API	Description
Obtaining Overview Statistics	This API is used to obtain overview statistics.
Obtaining Model Statistics	This API is used to obtain statistics in a model.
Obtaining ER Modeling Statistics	This API is used to obtain outer-layer statistics on the ER modeling page.
Obtaining Standard Coverage Statistics	This API is used to obtain the coverage of a data standard in all model fields, that is, the percentage of fields that use the standard to the total fields.

Information Architecture

**Table 3** Information architecture
API	Description
Querying Tables	This API is used to query multiple types of tables, including logical entities, physical tables, dimension tables, fact tables, and summary tables.

Data Standard

**Table 4** Data standard
API	Description
Querying Data Standards	This API is used to query data standards and sort them by modification time in descending order.
Creating a Data Standard	This API is used to create a data standard.
Deleting a Data Standard	This API is used to delete a data standard.
Modifying a Data Standard	This API is used to modify a data standard.
Querying Data Standard Details	This API is used to query the details of a data standard with a specified ID.
Associating Attributes with a Data Standard	This API is used to associate attributes with a data standard.

Data Source

**Table 5** Data source
API	Description
Obtaining Data Connections	This API is used to obtain data connections of a specified type.

Lookup Table Management

**Table 6** Lookup table management
API	Description
Querying the Lookup List	This API is used to query the lookup table list.
Creating a Lookup Table	This API is used to create a lookup table.
Deleting Lookup Tables	This API is used to delete lookup tables.
Modifying a Lookup Table	This API is used to modify a lookup table.
Querying Lookup Table Details	This API is used to query details about a lookup table by ID.
Querying Field Values in a Lookup Table	This API is used to query field values in a lookup table.
Editing Field Values in a Lookup Table	This API is used to edit field values in a lookup table.

Catalog

**Table 7** Catalog
API	Description
Obtaining the Tree of All Catalogs	This API is used to obtain the tree of all catalogs.
Querying the Catalog List	This API is used to query the catalog list.
Creating a Catalog	This API is used to create a catalog.
Modifying a Catalog	This API is used to modify a catalog.
Deleting a Catalog	This API is used to delete a catalog.
Querying Catalog Details	This API is used to query the details of a catalog.

Data Standard Template

**Table 8** Data standard template
API	Description
Querying Data Standard Templates	This API is used to query the data standard templates in the current workspace.
Creating a Data Standard Template	This API is used to create a data standard template in the current workspace.
Modifying a Data Standard Template	This API is used to modify a data standard template.
Deleting a Data Standard Template	This API is used to delete a data standard template.
Initializing a Data Standard Template	This API is used to initialize a data standard template.

Approval Management

**Table 9** Approval management
API	Description
Obtaining an Application	This API is used to obtain an application.
Withdrawing an Application	This API is used to withdraw an application.
Processing Applications	This API is used to reject or approve one or more applications.
Batch Publishing Resources	This API is used to publish resources in batches.
Batch Unpublishing Resources	This API is used to unpublish resources in batches.
Creating a Reviewer	This API is used to create a reviewer.
Querying the Reviewer List	This API is used to query the reviewer list.
Deleting a Reviewer	This API is used to delete a reviewer.
Deleting the Extension of an Entity	When a released entity is edited, an extension is generated. This API is used to delete the extension information of the entity.
Obtaining the Difference Between the Extension Information and a Released Entity	When a released entity is edited, an extension is generated. This interface is used to obtain the difference between the extension information and the released entity.

Subject Management

**Table 10** Subject management
API	Description
Querying the Subject List	This API is used to query subjects by name (fuzzy query is supported), creator, owner, status, or modification time.
Deleting a Subject	This API is used to delete a subject.
Creating a Subject	This API is used to create a subject.
Modifying a Subject	This API is used to modify a subject.
Obtaining Subject Tree Information	This API is used to obtain the data asset subject tree information, including l1, l2, and l3.
Querying the Subject List (New)	This API is used to query the subject list.
Deleting a Subject (New)	This API is used to delete a subject.
Creating a Subject (New)	This API is used to create a subject.
Modifying a Subject (New)	This API is used to modify a subject.

Subject Level

**Table 11** Subject level
API	Description
Obtaining a Subject Level	This API is used to obtain a subject level.
Modifying or Deleting a Subject Level	This API is used to modify or delete a subject level.

Directory Management

**Table 12** Directory management
API	Description
Obtaining All Directories	This API is used to obtain all directories of data standards and lookup tables.
Creating a Directory	This API is used to create a directory of data standards or lookup tables.
Modifying a Directory	This API is used to modify a directory of data standards or lookup tables.
Deleting a Directory	This API is used to delete a directory of data standards or lookup tables.

Atomic Metric

**Table 13** Atomic metric
API	Description
Querying Atomic Metrics	This API is used to query atomic metrics by name, creator, reviewer, status, or modification time. Fuzzy query is supported.
Creating an Atomic Metric	This API is used to create an atomic metric.
Updating an Atomic Metric	This API is used to update an atomic metric.
Deleting Atomic Metrics	This API is used to delete atomic metrics.
Querying Atomic Metric Details	This API is used to obtain the details of an atomic metric with a specified ID.

Derivative Metric

**Table 14** Derivative metric
API	Description
Querying Derivative Metrics	This API is used to query derivative metrics by name, creator, reviewer, status, modification time, or l3Id.
Creating a Derivative Metric	This API is used to create a derivative metric based on parameters.
Updating a Derivative Metric	This API is used to update a derivative metric.
Deleting a Derivative Metric	This API is used to delete a derivative metric with a specified ID.
Querying Derivative Metric Details	This API is used to obtain the details of a derivative metric with a specified ID.

Compound Metric

**Table 15** Compound metric
API	Description
Querying Compound Metrics	This API is used to query compound metrics by name, creator, reviewer, status, modification time, or l3Id.
Creating a Compound Metric	This API is used to create a compound metric based on parameters.
Updating a Compound Metric	This API is used to update a compound metric based on parameters.
Deleting a Compound Metric	This API is used to delete a compound metric with a specified ID set.
Querying Compound Metric Details	This API is used to obtain the details of a compound metric with a specified ID.

Dimension

**Table 16** Dimension
API	Description
Querying Dimensions	This API is used to query dimensions by name, description, creator, reviewer, status, l3Id, derivative metric idList, or modification time.
Creating a Dimension	This API is used to create a dimension based on parameters.
Updating a Dimension	This API is used to update a dimension based on parameters.
Deleting a Dimension	This API is used to delete a dimension with a specified ID.
Querying Dimension Details	This API is used to query the details of a dimension with a specified ID.
Querying Dimension Granularities	This API is used to query the granularities of all dimensions based on tableId. If tableId is not transferred, the granularities of all dimension groups are queried.
Querying a Dimension Table Reversing Task	This API is used to query a dimension table reversing task.

Filter

**Table 17** Filter
API	Description
Querying a Service Filter	This API is used to query filter information by name, description, creator, reviewer, filter group ID, modification time, and status.
Querying Filter Details	This API is used to query the details of a filter with a specified ID.

Dimension Table

**Table 18** Dimension table
API	Description
Querying Dimension Tables	This API is used to query dimension tables by name, creator, reviewer, status, or modification time.
Deleting a Dimension Table	This API is used to delete a dimension table with a specified ID.
Querying Dimension Table Details	This API is used to query the details about a dimension table by ID.

Fact Table

**Table 19** Fact table
API	Description
Querying Fact Tables	This API is used to query fact tables by name, creator, reviewer, status, or modification time.
Deleting Fact Tables	This API is used to delete fact tables with specified IDs.
Querying Fact Table Details	This API is used to query the details of a fact table with a specified ID.
Querying a Fact Table Reversing Task	This API is used to query a fact table reversing task.

Summary Table

**Table 20** Summary table
API	Description
Querying Summary Tables	This API is used to query summary tables by name, creator, reviewer, status, or modification time. Fuzzy query is supported.
Creating a Summary Table	This API is used to create a summary table.
Updating a Summary Table	This API is used to update a summary table.
Deleting Summary Tables	This API is used to delete summary tables in draft, unpublished, or rejected state.
Querying Summary Table Details	This API is used to query the details of a summary table with a specified ID.

Business Metric

**Table 21** Business metric
API	Description
Querying Business Metrics	This API is used to query business metrics by name, creator, or modification time.
Creating a Business Metric	This API is used to create a business metric.
Updating a Business Metric	This API is used to update a business metric.
Deleting a Business Metric	This API is used to delete a business metric.
Querying Metric Details	This API is used to query the details of a metric with a specified ID.
Querying Metric Dimension Information	This API is used to query the dimension information of a metric.
Querying the Metric Owner	This API is used to query the owner of a metric.
Obtaining Metric Association Information	This API is used to obtain the current metric graph.

Version Information

**Table 22** Version information
API	Description
Querying Version Information	This API is used to query version information by name, creator, or modification time.
Comparing Versions	This API is used to compare two versions with different IDs.

ER Modeling

**Table 23** ER modeling
API	Description
Querying Table Models	This API is used to query table models, including logical entities, physical tables, and their attributes, by name, creator, reviewer, status, or modification time.
Creating a Table Model	This API is used to create a table model (logical entity or physical table).
Updating a Table Model	This API is used to update a table model (logical entity or physical model) and its attributes.
Deleting a Table Model	This API is used to delete a table model (logical entity or physical model) and its attributes.
Querying Relationships	This API is used to query relationships by name, creator, start time, or end time. Fuzzy query is supported.
Querying Relationship Details	This API is used to obtain the details of a relationship with a specified ID.
Querying All Relationships in a Model	This API is used to query all relationships in a model.
Querying Table Model Details	This API is used to obtain the details of a table model with a specified ID.
Obtaining Models	This API is used to obtain all models in the current workspace.
Creating a Model Workspace	This API is used to create a model workspace.
Updating a Model Workspace	This API is used to update a model workspace.
Deleting a Model Workspace	This API is used to delete a model workspace.
Querying Model Details	This API is used to query the workspace details of a physical or logical model.
Querying Destination Tables and Fields (to Be Taken Offline)	This API is used to query destination tables and fields.
Exporting DDL Statements of a Table in a Model	This API is used to export the DDL statements of a specified table based on the model ID.
Converting a Logical Model to a Physical Model	This API is used to convert a logical model to a physical model and returns information about the target model.
Obtaining the Operation Result	This API is used to obtain the result of a batch operation, for example, converting a logical model to a physical model and reversing a database.

Import and Export

**Table 24** Import and export
API	Description
Importing Subjects	This API is used to import subjects.
Importing ER Models, Dimension Models, Lookup Tables, Business metrics, or Catalogs	This API is used to import ER models, dimension models, lookup tables, business metrics, or catalogs
Querying the Import Result	This API is used to query the processing result of the imported Excel file. The value of uuid can be obtained via the /design/models/action or /design/catalogs/action API.
Exporting Service Data	This API is used to export service data, including lookup tables, data standards, atomic metrics, derivative metrics, compound metrics, summary tables, business metrics, subjects, processes, logical models, physical models, dimensions, and fact tables.
Obtaining the Exported Excel	This API is used to obtain the exported Excel based on the UUID returned by the /export-model API.

Custom Item

**Table 25** Customized item
API	Description
Querying Custom Items	This API is used to query custom items of tables, attributes, subjects, or business metrics.
Modifying a Custom Item	This API is used to modify a custom table, attribute, subject, or business metric item.

Tag

**Table 26** Tag
API	Description
Adding Tags	This API is used to add tags to an asset (table or attribute) with a specified ID.
Deleting Tags	This API is used to delete tags of an asset (table or attribute) with a specified ID.

Quality Rule

**Table 27** Quality rule
API	Description
Updating Abnormal Data Output Configuration of a Table	This API is used to update the abnormal data output configuration of a table, including whether to generate abnormal data, database or schema for storing abnormal data, and prefix or suffix of an abnormal table.
Clearing Quality Rules	This API is used to clear quality rules of a table.