Obtaining Rule Template Details
Function
This API is used to obtain the details of a rule template.
URI
GET /v2/{project_id}/quality/rule-templates/{id}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
project id |
|
id |
Yes |
Long |
id |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
workspace |
Yes |
String |
Workspace information |
|
X-Auth-Token |
Yes |
String |
token |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
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
|
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
|
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 |
Example Requests
None
Example Responses
None
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Success |
|
400 |
BadRequest |
|
500 |
INTERNAL SERVER ERROR |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
