Help Center/ DataArts Studio/ API Reference/ API Overview/ DataArts Quality API Overview
Updated on 2024-11-06 GMT+08:00
View PDF
Share

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

Quality Report

Quality report APIs

Import/Export

Import and export APIs

Directory

Table 2 Directory

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining Job Directories

This API is used to obtain job directories.

300

40

Rule Template

Table 3 Rule template

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining the Rule Template List

This API is used to obtain the rule template list.

300

40

Creating a Rule Template

This API is used to create a rule template.

300

40

Obtaining Rule Template Details

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

300

40

Updating a Rule Template

This API is used to update a rule template.

300

40

Deleting Rule Templates

This API is used to delete rule templates.

300

40

Quality Job

Table 4 Quality job

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining the Quality Job List (V1)

This API is used to obtain quality jobs.

300

40

Obtaining the Quality Job List

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

300

40

Obtaining Quality Job Details

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

300

40

Comparison Job

Table 5 Comparison job

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining the Comparison Job List

This API is used to obtain the comparison job list.

300

40

Obtaining Comparison Job Details

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

300

40

O&M

Table 6 O&M

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining the Task Execution Result List

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

300

40

Obtaining the Instance Result

This API is used to obtain the instance result.

300

40

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.

300

40

Quality Report

Table 7 Quality report

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Obtaining a Quality Report Scoring System

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

300

40

Obtaining the Quality Report Overview

This API is used to obtain the quality report overview.

300

40

Obtaining the Quality Report Trend

This API is used to obtain the quality report trend.

300

40

Obtaining the Quality Report Rule Score

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

300

40

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.

300

40

Obtaining Technical Report Data

This API is used to obtain technical report data.

300

40

Obtaining Business Report Data

This API is used to obtain business report data.

300

40

Import and Export

Table 8 Import and export

API

Description

Maximum API Requests in 10 Seconds

Maximum User Requests in 10 Seconds

Exporting Resources

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

1800

20

Obtaining the Status of an Import/Export Task

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

300

40

Downloading a Resource File

This API is used to download a resource file.

300

40

Uploading a Resource File

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

1800

20

Importing Resources

This API is used to import resources to DataArts Quality.

1800

20
Parent Topic: API Overview