Obtaining the Rule Template List

This API is used to obtain the rule template list.

GET /v2/{project_id}/quality/rule-templates

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	project id

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
category_id	No	Long	category id Default: 0
name	No	String	name
system_template	No	Boolean	Whether to query only system templates Default: false
creator	No	String	Creator
limit	No	Integer	Pagination limit. The maximum value is 100. Default: 10
offset	No	Integer	Pagination offset Default: 0

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
workspace	Yes	String	Workspace information
X-Auth-Token	Yes	String	token

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
count	Long	Total number of records
resources	Array of RuleTemplateDetailVO objects	Number of records on each page

**Table 5** RuleTemplateDetailVO
Parameter	Type	Description
id	Long	id
name	String	name
category_id	Long	Catalog ID
dimension	String	Dimension. The value can be Completeness, Uniqueness, Timelines, Validity, Accuracy, or Consistency.
type	String	Rule type. The options are as follows: Field: field-level rule; Table: table-level rule; Database: database-level rule; Cross-field: cross-field rule; Customize: custom rule.
system_template	Boolean	Whether the template is a system template
sql_info	String	SQL information
result_description	String	Result description
create_time	Long	Creation time. The value is a 13-digit timestamp accurate to millisecond.
creator	String	Creator. Value System indicates that the creator is provided by the system.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed.
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code, for example, DQC.0000 which indicates that the request was successfully processed.
error_msg	String	Error message

None

None

Parent topic: Rule Template APIs

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel