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

DataArts Quality API Overview

Table 1 DataArts Quality API types

Type

Description

Catalog

Catalog APIs

Rule Template

Rule template APIs

Quality Job

Quality job APIs

Comparison Job

Comparison job APIs

O&M

O&M APIs

Task Instance

Task instance APIs

Quality Report

Quality report APIs

Import/Export

Import and export APIs

Directory

Table 2 Directory

API

Description

Obtaining Job Directories

This API is used to obtain job directories.

Rule Template

Table 3 Rule template

API

Description

Obtaining the Rule Template List

This API is used to obtain the rule template list.

Creating a Rule Template

This API is used to create a rule template.

Obtaining Rule Template Details

This API is used to obtain the details of a rule template.

Updating a Rule Template

This API is used to update a rule template.

Deleting Rule Templates

This API is used to delete rule templates.

Quality Job

Table 4 Quality job

API

Description

Obtaining the Quality Job List (V1)

This API is used to obtain quality jobs.

Obtaining the Quality Job List

This API is used to obtain the list of quality jobs.

Obtaining Quality Job Details

This API is used to obtain the details of a quality job.

Deleting Quality Jobs

This API is used to delete quality jobs.

Comparison Job

Table 5 Comparison job

API

Description

Obtaining the Comparison Job List

This API is used to obtain the comparison job list.

Obtaining Comparison Job Details

This API is used to obtain the details of a comparison job.

Deleting Comparison Jobs

This API is used to delete comparison jobs.

O&M

Table 6 O&M

API

Description

Obtaining the Task Execution Result List

This API is used to obtain the task execution result list.

Obtaining the Instance Result

This API is used to obtain the instance result.

Rectifying Issues of an Instance

This API is used to rectify issues of an instance. On the DataArts Quality console, you can click More and select Rectify to rectify issues.

Task Instance

Table 7 Task instance

API

Description

Stopping Instances

This API is used to stop job instances.

Quality Report

Table 8 Quality report

API

Description

Obtaining a Quality Report Scoring System

This API is used to obtain a quality report scoring system.

Obtaining the Quality Report Overview

This API is used to obtain the quality report overview.

Obtaining the Quality Report Trend

This API is used to obtain the quality report trend.

Obtaining the Quality Report Rule Score

This API is used to obtain the score of a quality report rule.

Obtaining the Score of a Sub-rule Field in the Quality Report

This API is used to obtain the score of a sub-rule field in the quality report.

Obtaining Technical Report Data

This API is used to obtain technical report data.

Obtaining Business Report Data

This API is used to obtain business report data.

Import and Export

Table 9 Import and export

API

Description

Exporting Resources

This API is used to export resources from DataArts Quality, such as quality jobs and comparison jobs.

Obtaining the Status of an Import/Export Task

This API is used to obtain the status of an export or import task.

Downloading a Resource File

This API is used to download a resource file.

Uploading a Resource File

This API is used to import a file to DataArts Quality.

Importing Resources

This API is used to import resources to DataArts Quality.