Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts Catalog API Overview
Updated on 2025-11-17 GMT+08:00

DataArts Catalog API Overview

Table 1 DataArts Catalog API types

Type

Description

Logical Asset

Logical asset APIs

Metric Asset

Metric asset APIs

Asset Statistics

Asset statistics APIs

Asset Management

Asset management APIs

Asset Classification

Asset classification APIs

Asset Security Level

Asset security level APIs

Asset

Asset APIs

Lineage

Lineage

Metadata Collection Task

Metadata collection task APIs

Tag

Tag APIs

Data Map

Data map APIs

Logical Asset

Table 2 Logical asset

API

Description

Querying Logical Assets

This API is used to query logical assets, including business objects and logical entities synchronized from DataArts Architecture.

Querying the Logical Asset Directory Tree

This API is used to query the directory tree of logical assets, including business objects and logical entities synchronized from DataArts Architecture.

Metric Asset

Table 3 Metric asset

API

Description

Querying the Metric Asset Directory Tree

This API is used to query the metric asset directory tree.

Querying Metric Assets

This API is used to query metric assets.

Asset Statistics

Table 4 Asset statistics

API

Description

Obtaining Technical Asset Statistics

This API is used to obtain technical asset statistics.

Obtaining Logical Asset Statistics

This API is used to obtain logical asset statistics.

Asset Management

Table 5 Asset management

API

Description

Querying a Technical Asset

This API is used to query a technical asset.

Obtaining Asset Details by GUID

This API is used to obtain table details based on the table GUID. The table details include column information. You can also obtain column information based on the column GUID.

Adding or Modifying an Asset

This API is used to add or modify an asset.

Deleting an Asset

This API is used to delete an asset.

Asset Classification

Table 6 Asset classification

API

Description

Associating Assets with a Classification

This APi is used to associate assets (columns of tables and OBS objects) with a classification.

Associating a Classification with One or More Assets

This API is used to associate a classification with one or more assets with specified GUIDs.

Disassociating a Classification from an Asset

This API is used to disassociate a classification from an asset.

Asset Security Level

Table 7 Asset security level

API

Description

Associating Assets with a Security Level

This API is used to associate assets with a security level.

Associating an Asset with a Security Level

This API is used to associate an asset with a specified security level.

Disassociating an Asset from a Security Level

This API is used to disassociate an asset from a security level.

Asset

Table 8 Asset

API

Description

Querying the Asset Summary

This API is used to query the asset summary.

Querying the Summary of Specified Fields

This API is used to query the summary of specified fields.

Lineage

Table 9 Lineage

API

Description

Querying Tables Without Lineages

This API is used to query tables without lineages based on type_names, classification, type_names, connection_names, or query.

Querying Lineages

This API is used to query lineages.

Importing a Lineage

This API is used to import a lineage.

Creating a Lineage

This API is used to create a lineage.

Metadata Collection Task

Table 10 Metadata collection task

API

Description

Querying the Collection Task List

This API is used to query the collection task list.

Creating a Collection Task

This API is used to create a collection task.

Querying the Collection Task Details

This API is used to query the details about a collection task.

Editing a Collection Task

This API is used to edit a collection task.

Deleting a Collection Task

This API is used to delete a collection task.

Starting, Scheduling, and Stopping a Collection Task

This API is used to start, schedule, and stop a collection task.

Obtaining Logs of a Metadata Collection Task

This API is used to obtain the logs of a metadata collection task.

Tag APIs

Table 11 Tag APIs

API

Description

Querying the Tag List

This API is used to query the tag list.

Associating a Tag with an Asset

This API is used to associate a tag with an asset.

Data Map

Table 12 Data map

API

Description

Synchronizing Metadata in Real Time (Invitational Test)

This API is used to synchronize metadata in real time. It is in invitational test and will be available for OBT in the future.

Displaying Search and Query Tags on Multiple Pages (Invitational Test)

This API is used to display search and query tags on multiple pages. It is in invitational test and will be available for OBT in the future.

Analyzing User Behavior (Invitational Test)

This API is used to analyze user behavior. It is in invitational test and will be available for OBT in the future.

Searching for Assets (Invitational Test)

This API is used to search for assets. It is in invitational test and will be available for OBT in the future.

Creating or Modifying an Asset (Invitational Test)

This API is used to create or modify an asset. It is in invitational test and will be available for OBT in the future.

Obtaining Asset Details (Invitational Test)

This API is used to obtain asset details. It is in invitational test and will be available for OBT in the future.

Obtaining Asset Lineages (Invitational Test)

This API is used to obtain asset lineages. It is in invitational test and will be available for OBT in the future.

Obtaining Asset Lineages (Invitational Test)

This API is used to obtain the lineages of all job nodes. It is in invitational test and will be available for OBT in the future.

Querying the List of Operators Associated with Tables (Invitational Test)

This API is used to query the list of job operators associated with a table. It is in invitational test and will be available for OBT in the future.

Querying the Instances of Operators Associated with a Table (Invitational Test)

This API is used to query the instances of job operators associated with a table. It is in invitational test and will be available for OBT in the future.

Tagging Assets (Invitational Test)

This API is used to tag assets.