Obtaining Rule Template Details
Function
This API is used to obtain the details of a rule template.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/quality/rule-templates/{id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. For details about how to obtain it, see Project ID and Account ID. |
| id | Yes | Long | Rule template ID |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| workspace | Yes | String | DataArts Studio workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
| X-Auth-Token | Yes | String | IAM token. For details about how to obtain the token, see Authentication. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Rule template ID |
| name | String | Rule template name |
| category_id | Long | Directory ID |
| dimension | String | Dimension, which can be Completeness, Uniqueness, Timeliness, Validity, Accuracy, or Consistency |
| type | String | Rule type. Field indicates a field rule, Table indicates a table rule, Database indicates a database rule, Cross-field indicates a cross-field rule, and Customize indicates a 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
Status code: 200
Success
{
"id" : 1012384820829081600,
"name" : "test",
"dimension" : "Uniqueness",
"sql_info" : "select count(*) from ${Schema_Table1}",
"category_id" : 0,
"type" : "Table",
"system_template" : false,
"create_time" : 1661412950486,
"creator" : "ei",
"result_description" : "row : ${1}"
} 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.
