DataArts Catalog API Overview
| Type | Description |
|---|---|
| Logical asset APIs | |
| Metric asset APIs | |
| Asset statistics APIs | |
| Asset management APIs | |
| Asset classification APIs | |
| Asset security level APIs | |
| Asset APIs | |
| Lineage | |
| Metadata collection task APIs | |
| Tag APIs | |
| Data map APIs |
Logical Asset
| API | Description |
|---|---|
| This API is used to query logical assets, including business objects and logical entities synchronized from DataArts Architecture. | |
| This API is used to query the directory tree of logical assets, including business objects and logical entities synchronized from DataArts Architecture. |
Metric Asset
| API | Description |
|---|---|
| This API is used to query the metric asset directory tree. | |
| This API is used to query metric assets. |
Asset Statistics
| API | Description |
|---|---|
| This API is used to obtain technical asset statistics. | |
| This API is used to obtain logical asset statistics. |
Asset Management
| API | Description |
|---|---|
| This API is used to query a technical asset. | |
| 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. | |
| This API is used to add or modify an asset. | |
| This API is used to delete an asset. |
Asset Classification
| API | Description |
|---|---|
| This APi is used to associate assets (columns of tables and OBS objects) with a classification. | |
| This API is used to associate a classification with one or more assets with specified GUIDs. | |
| This API is used to disassociate a classification from an asset. |
Asset Security Level
| API | Description |
|---|---|
| This API is used to associate assets with a security level. | |
| This API is used to associate an asset with a specified security level. | |
| This API is used to disassociate an asset from a security level. |
Asset
| API | Description |
|---|---|
| This API is used to query the asset summary. | |
| This API is used to query the summary of specified fields. |
Lineage
| API | Description |
|---|---|
| This API is used to query tables without lineages based on type_names, classification, type_names, connection_names, or query. | |
| This API is used to query lineages. | |
| This API is used to import a lineage. | |
| This API is used to create a lineage. |
Metadata Collection Task
| API | Description |
|---|---|
| This API is used to query the collection task list. | |
| This API is used to create a collection task. | |
| This API is used to query the details about a collection task. | |
| This API is used to edit a collection task. | |
| This API is used to delete a collection task. | |
| This API is used to start, schedule, and stop a collection task. | |
| This API is used to obtain the logs of a metadata collection task. |
Tag APIs
| API | Description |
|---|---|
| This API is used to query the tag list. | |
| This API is used to associate a tag with an asset. |
Data Map
| API | Description |
|---|---|
| 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. |
| This API is used to analyze user behavior. It is in invitational test and will be available for OBT in the future. | |
| This API is used to search for assets. It is in invitational test and will be available for OBT in the future. | |
| This API is used to create or modify an asset. It is in invitational test and will be available for OBT in the future. | |
| This API is used to obtain asset details. It is in invitational test and will be available for OBT in the future. | |
| This API is used to obtain asset lineages. It is in invitational test and will be available for OBT in the future. | |
| 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. |
| This API is used to tag assets. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.