API Overview

DataArts Studio provides self-developed APIs that comply with RESTful API design specifications. You can call those APIs to perform operations on DataArts Studio.

**Table 1** DataArts Migration APIs
Type	API	Description	Maximum Number of Requests Made Per User Per Minute
Cluster Management	Creating a Cluster	Used to create a CDM cluster.	5
	Querying the Cluster List	Used to query the list of CDM clusters.	120
	Querying Cluster Details	Used to query the details of a CDM cluster.	120
	Restarting a Cluster	Used to restart a CDM cluster.	20
	Deleting a Cluster	Used to delete a CDM cluster.	20
	Stopping a Cluster	Used to stop a CDM cluster.	20
	Starting a Cluster	Used to start a CDM cluster.	20
Job Management	Creating a Link	Used to connect to a data source.	120
	Querying a Link	Used to query the link list.	120
	Modifying a Link	Used to modify the link configuration.	120
	Deleting a Link	Used to delete a link.	120
Job Management	Creating a Job in a Specific Cluster	Used to create a data migration job in a specific CDM cluster. The job will not automatically start.	1200
	Creating and Executing a Job in a Random Cluster	Used to select a random cluster in the running state from the specified clusters and create and execute a data migration job.	120
	Querying a Job	Used to query the job list.	120
	Modifying a Job	Used to modify the job configuration.	120
	Starting a Job	Used to start a data migration job.	1200
	Stopping a Job	Used to stop a running job.	1200
	Querying Job Status	Used to query the running status of a job.	120
	Querying Job Execution History	Used to query the historical status of job execution.	120
	Deleting a job	Used to delete a job.	120

**Table 2** DataArts Factory APIs
Type	Description
Connection Management APIs	Used to create, edit, delete, and export data connections, query the data connection list, and query data connection details. For details, see DataArts Factory > Data Management > Creating a Data Connection in the User Guide.
Script Development APIs	Used to delete and execute scripts. For details, see DataArts Factory > Script Development in the User Guide.
Resource Management APIs	Used to perform operations such as deleting resources. For details, see DataArts Factory > Configuration and Management > Managing a Resource in the User Guide.
Job Development APIs	Used to delete jobs and query job files. For details, see DataArts Factory > Job Development in the User Guide.
APIs to Be Taken Offline	A collection of data development APIs that need to be optimized. Currently, these APIs work properly, including the APIs used to create, query, and modify scripts, create, query, and modify resources, and create and edit jobs.

**Table 3** DataArts Architecture APIs
Type	Description
Overview APIs	Used to view the overall statistics.
Data Standard APIs	Used to create and manage data standards, and associate attributes with data standards.
Lookup Table Management APIs	Used to create and manage lookup tables.
Catalog APIs	Used to create and manage catalogs, and search for processes.
Data Standard Template APIs	Used to create and manage data standard templates.
Approval Management APIs	Used to manage reviewers and create and process applications.
Subject Management APIs	Used to create and manage subjects.
Subject Level APIs	Used to obtain, modify, and delete subject levels.
Catalog Management APIs	Used to perform operations such as obtaining directories.
Atomic Metric APIs	Used to perform operations such as querying atomic metrics.
Derivative Metric APIs	Used to perform operations such as querying derivative metrics.
Compound Metric APIs	Used to perform operations such as querying compound metrics.
Dimension APIs	Used to perform operations such as querying dimensions and dimension details.
Filter APIs	Used to perform operations such as querying filters and filter details.
Dimension Table APIs	Used to perform operations such as querying dimension tables and dimension table details.
Fact Table APIs	Used to perform operations such as querying fact tables and fact table details.
Summary Table APIs	Used to perform operations such as querying summary tables and summary table details.
Business Metric APIs	Used to perform operations such as querying business metrics and business metric details.
Version Information APIs	Used to query versions based on the name, creator, and modification time.
ER Modeling APIs	Used to perform operations such as querying model entities, relationship details, and table models.
Import/Export APIs	Used to import ER models, dimensional models, lookup tables, business metrics, and process architecture, and query the import result.

**Table 4** DataArts Quality APIs
Type	Description
Catalog APIs	Used to obtain the directory list.
Rule Template APIs	Used to obtain the rule template list and details about a specified rule template.
Quality Job APIs	Used to obtain the quality job list and job details.
Comparison Job APIs	Used to obtain the comparison job list and job details.
O&M APIs	Used to perform operations such as obtaining task execution results.

**Table 5** DataArts Catalog APIs
Type	Description
Logical Asset APIs	Used to perform operations such as querying logical assets.
Metric Asset APIs	Used to perform operations such as querying metric assets.
Asset Statistics APIs	Used to perform operations such as obtaining statistics of logical assets or technical assets.
Asset Management APIs	Used to query asset details and technical assets.
Asset Classification APIs	Used to associate or remove asset classifications.
Asset Security Level APIs	Used to associate or remove asset security levels.

**Table 6** DataArts DataService APIs
Type	Description
API Management	Used to create, debug, publish, manage, and authorize APIs.
Authorization Management	Used to perform operations such as querying authorized apps of an API and querying authorized APIs of an app.
Application Management	Used to query the application list in the Review Center, review applications, and obtain application details.
Message Management	Used to query the message list, process messages, and obtain message details.
Service Catalog Management	Used to create and manage service catalogs.
Gateway Management	Used to obtain the gateway instance list and gateway group list.
App Management	Used to create and manage apps.
Overview APIs	Used to query API development and calling metrics, and query top N APIs.