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

Updated on 2024-12-03 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	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining Overview Statistics	This API is used to obtain overview statistics.	21,600	240
Obtaining Model Statistics	This API is used to obtain statistics in a model.	21,600	240
Obtaining ER Modeling Statistics	This API is used to obtain outer-layer statistics on the ER modeling page.	21,600	240
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.	21,600	240

Information Architecture

**Table 3** Information architecture
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Tables	This API is used to query multiple types of tables, including logical entities, physical tables, dimension tables, fact tables, and summary tables.	21,600	240

Data Standard

**Table 4** Data standard
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Data Standards	This API is used to query data standards and sort them by modification time in descending order.	21,600	240
Creating a Data Standard	This API is used to create a data standard.	10,800	120
Deleting a Data Standard	This API is used to delete a data standard.	10,800	120
Modifying a Data Standard	This API is used to modify a data standard.	10,800	120
Querying Data Standard Details	This API is used to query the details of a data standard with a specified ID.	21,600	240
Associating Attributes with a Data Standard	This API is used to associate attributes with a data standard.	10,800	120

Data Source

**Table 5** Data source
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining Data Connections	This API is used to obtain data connections of a specified type.	21,600	240

Lookup Table Management

**Table 6** Lookup table management
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying the Lookup List	This API is used to query the lookup table list.	21,600	240
Creating a Lookup Table	This API is used to create a lookup table.	10,800	120
Deleting Lookup Tables	This API is used to delete lookup tables.	10,800	120
Modifying a Lookup Table	This API is used to modify a lookup table.	10,800	120
Querying Lookup Table Details	This API is used to query details about a lookup table by ID.	21,600	240
Querying Field Values in a Lookup Table	This API is used to query field values in a lookup table.	21,600	240
Editing Field Values in a Lookup Table	This API is used to edit field values in a lookup table.	10,800	120

Catalog

**Table 7** Catalog
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining the Tree of All Catalogs	This API is used to obtain the tree of all catalogs.	21,600	240
Querying the Catalog List	This API is used to query the catalog list.	21,600	240
Creating a Catalog	This API is used to create a catalog.	10,800	120
Modifying a Catalog	This API is used to modify a catalog.	10,800	120
Deleting a Catalog	This API is used to delete a catalog.	10,800	120
Querying Catalog Details	This API is used to query the details of a catalog.	21,600	240

Data Standard Template

**Table 8** Data standard template
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Data Standard Templates	This API is used to query the data standard templates in the current workspace.	21,600	240
Creating a Data Standard Template	This API is used to create a data standard template in the current workspace.	10,800	120
Modifying a Data Standard Template	This API is used to modify a data standard template.	10,800	120
Deleting a Data Standard Template	This API is used to delete a data standard template.	10,800	120
Initializing a Data Standard Template	This API is used to initialize a data standard template.	10,800	120

Approval Management

**Table 9** Approval management
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining an Application	This API is used to obtain an application.	21,600	240
Withdrawing an Application	This API is used to withdraw an application.	10,800	120
Processing Applications	This API is used to reject or approve one or more applications.	10,800	120
Batch Publishing Resources	This API is used to publish resources in batches.	10,800	120
Batch Unpublishing Resources	This API is used to unpublish resources in batches.	10,800	120
Creating a Reviewer	This API is used to create a reviewer.	10,800	120
Querying the Reviewer List	This API is used to query the reviewer list.	21,600	240
Deleting a Reviewer	This API is used to delete a reviewer.	10,800	120
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.	10,800	120
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.	21,600	240

Subject Management

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

Subject Level

**Table 11** Subject level
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining a Subject Level	This API is used to obtain a subject level.	21,600	240
Modifying or Deleting a Subject Level	This API is used to modify or delete a subject level.	10,800	120

Directory Management

**Table 12** Directory management
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Obtaining All Directories	This API is used to obtain all directories of data standards and lookup tables.	21,600	240
Creating a Directory	This API is used to create a directory of data standards or lookup tables.	10,800	120
Modifying a Directory	This API is used to modify a directory of data standards or lookup tables.	10,800	120
Deleting a Directory	This API is used to delete a directory of data standards or lookup tables.	10,800	120

Atomic Metric

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

Derivative Metric

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

Compound Metric

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

Dimension

**Table 16** Dimension
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Dimensions	This API is used to query dimensions by name, description, creator, reviewer, status, l3Id, derivative metric idList, or modification time.	21,600	240
Creating a Dimension	This API is used to create a dimension based on parameters.	10,800	120
Updating a Dimension	This API is used to update a dimension based on parameters.	10,800	120
Deleting a Dimension	This API is used to delete a dimension with a specified ID.	10,800	120
Querying Dimension Details	This API is used to query the details of a dimension with a specified ID.	21,600	240
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.	21,600	240
Querying a Dimension Table Reversing Task	This API is used to query a dimension table reversing task.	21,600	240

Filter

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

Dimension Table

**Table 18** Dimension table
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Dimension Tables	This API is used to query dimension tables by name, creator, reviewer, status, or modification time.	21,600	240
Deleting a Dimension Table	This API is used to delete a dimension table with a specified ID.	10,800	120
Querying Dimension Table Details	This API is used to query the details about a dimension table by ID.	21,600	240

Fact Table

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

Summary Table

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

Business Metric

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

Version Information

**Table 22** Version information
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Version Information	This API is used to query version information by name, creator, or modification time.	21,600	240
Comparing Versions	This API is used to compare two versions with different IDs.	60	24

ER Modeling

**Table 23** ER modeling
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
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.	21,600	240
Creating a Table Model	This API is used to create a table model (logical entity or physical table).	10,800	120
Updating a Table Model	This API is used to update a table model (logical entity or physical model) and its attributes.	10,800	120
Deleting a Table Model	This API is used to delete a table model (logical entity or physical model) and its attributes.	10,800	120
Querying Relationships	This API is used to query relationships by name, creator, start time, or end time. Fuzzy query is supported.	21,600	240
Querying Relationship Details	This API is used to obtain the details of a relationship with a specified ID.	21,600	240
Querying All Relationships in a Model	This API is used to query all relationships in a model.	21,600	240
Querying Table Model Details	This API is used to obtain the details of a table model with a specified ID.	21,600	240
Obtaining Models	This API is used to obtain all models in the current workspace.	21,600	240
Creating a Model Workspace	This API is used to create a model workspace.	10,800	120
Updating a Model Workspace	This API is used to update a model workspace.	10,800	120
Deleting a Model Workspace	This API is used to delete a model workspace.	10,800	120
Querying Model Details	This API is used to query the workspace details of a physical or logical model.	21,600	240
Querying Destination Tables and Fields (to Be Taken Offline)	This API is used to query destination tables and fields.	21,600	240
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.	10	4
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.	10,800	120
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.	21,600	240

Import and Export

**Table 24** Import and export
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Importing Subjects	This API is used to import subjects.	10	4
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	10	4
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.	21,600	240
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.	10	4
Obtaining the Exported Excel	This API is used to obtain the exported Excel based on the UUID returned by the /export-model API.	21,600	240

Custom Item

**Table 25** Customized item
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Querying Custom Items	This API is used to query custom items of tables, attributes, subjects, or business metrics.	21,600	240
Modifying a Custom Item	This API is used to modify a custom table, attribute, subject, or business metric item.	10,800	120

Tag

**Table 26** Tag
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
Adding Tags	This API is used to add tags to an asset (table or attribute) with a specified ID.	10,800	120
Deleting Tags	This API is used to delete tags of an asset (table or attribute) with a specified ID.	10,800	120

Quality Rule

**Table 27** Quality rule
API	Description	Maximum API Requests per Minute	Maximum User Requests per Minute
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.	10,800	120
Clearing Quality Rules	This API is used to clear quality rules of a table.	10,800	120