Retrieves a rule and its configuration details by ID. Provides scoring bands, metric group info and last run status if available.
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| ruleId | Yes | string |
The unique identifier of the rule to retrieve |
Response
The successful response returns the rule for the specified rule ID.
Response body properties
| Property | Required | Type | Description | |
|---|---|---|---|---|
| id | Yes | string | ||
| primaryMetricTypeId | Yes | string | ||
| supportingMetricTypeIds | Yes | array | ||
| name | Yes | string |
The unique identifier for the rule. This value is used to reference the rule within the system. |
|
| description | Yes | string |
A human-readable explanation describing the rule's purpose or intent. |
|
| captureFailedRecords | Yes | boolean |
This property may be set to |
|
| enableAutoRun | Yes | boolean |
This property may be set to |
|
| targetAssetGroups | Yes | array | ||
| runStatus | Yes | object | ||
| runStatus | correlationId | Yes | string | |
| runStatus | state | Yes | string | |
| runStatus | lastRunAt | Yes | string | |
| targetAssetCount | Yes | integer | ||
| passCondition | Yes | string | The specific criteria or thresholds a data element must meet to be considered acceptable: Note: We currently only support the
script type. |
|
| filterCondition | No | string |
An expression used to filter records in a dataset, ensuring only accurate, complete, and relevant data is used for analysis. |
|
| createdBy | Yes | string | ||
| createdDate | Yes | string |
|
|
| lastModifiedBy | Yes | string | ||
| lastModifiedDate | Yes | string |
|
|
| script | Yes | boolean |
This property may be set to |
|
| dimensionId | Yes | string | ||
| dimensionName | Yes | string | Specifies the data quality dimension that the rule addresses. The following values can be provided:
|
|
| scoreBands | Yes | array | ||
| scoreBands | label | Yes | string | |
| scoreBands | color | Yes | string | |
| scoreBands | minimumValue | Yes | string |
Response examples
Example status code responses for this method are shown here. To view response schemas, you can download the Data Quality APIs Open API Specification from the Precisely Developer Portal.
{
"id": "6929364c4e818705c17e7cd3",
"primaryMetricTypeId": "6929364c75b6770472abda72",
"supportingMetricTypeIds": [
"6929364c75b6770472abda73",
"66d1fec93824ef1a04ee6633"
],
"name": "SIT_03",
"description": "null",
"captureFailedRecords": true,
"enableAutoRun": true,
"targetAssetGroups": [
"6929364c6003e42ec3c6eb14"
],
"runStatus": {
"correlationId": "",
"state": "NotRun",
"lastRunAt": "2025-11-28T05:42:36.150Z"
},
"targetAssetCount": 1,
"passCondition": "FIRSTNAME is populated.",
"filterCondition": null,
"createdBy": "qa_douser_dev11@precisely.testinator.com",
"createdDate": "2025-11-28T05:42:36.150Z",
"lastModifiedBy": "qa_douser_dev11@precisely.testinator.com",
"lastModifiedDate": "2025-12-10T07:17:52.456Z",
"script": true,
"dimensionId": "66ac9fe6091f80486b23249c",
"dimensionName": "Completeness",
"scoreBands": [
{
"label": "Poor",
"color": "red",
"minimumValue": 0
},
{
"label": "Average",
"color": "orange",
"minimumValue": 0.8
},
{
"label": "Good",
"color": "green",
"minimumValue": 0.9
}
]
}{
"type":"about:blank",
"title":"Bad Request",
"status":"400",
"detail":"Invalid rule id",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b",
"errorCode":"DIS-QUALITY-RULES-USR-0003"
}{
"type":"about:blank",
"title":"Not Found",
"status":"404",
"detail":"Rule not found",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b",
"errorCode":"DIS-QUALITY-Rule-USR-1001"
}{
"type":"about:blank",
"title":"Internal Server Error",
"status":"500",
"detail":"An unexpected error occurred on the server",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b",
"errorCode":"DIS-QUALITY-RULES-SVC-0001"
}