Returns a paginated list of rule summaries. Optionally filters by asset ID if provided. Each summary includes key configuration and execution status.
Request
Query parameters
| Key | Required | Type | Description |
|---|---|---|---|
| assetId | No | string | Asset ID to filter rules |
| page | No | integer | Page number |
| limit | No | integer | Number of items per page |
Response
The successful response returns a paginated list of rules.
Response body properties
| Ancestors | Property | Required | Type | Description |
|---|---|---|---|---|
| items | Yes | array[object] | List of rules. | |
| items | id | Yes | string | |
| items | name | Yes | string |
The unique identifier for the rule. This value is used to reference the rule within the system. |
| items | description | Yes | string |
A human-readable explanation describing the rule's purpose or intent. |
| items | primaryMetricTypeId | Yes | string | |
| items | enableAutoRun | Yes | boolean |
This property may be set to |
| items | targetAssetCount | Yes | integer | |
| items | runStatus | Yes | object | |
| items/runStatus | correlationId | Yes | string | |
| items/runStatus | state | Yes | string | |
| items/runStatus | lastRunAt | Yes | string | |
| items | targetAssetGroups | Yes | array | |
| items | dimensionId | Yes | string | |
| items | dimensionName | Yes | string | Specifies the data quality dimension that the
rule addresses. The following values can be provided:
|
| pageSize | Yes | integer |
|
|
| currentPage | Yes | integer |
|
|
| totalItems | Yes | integer |
|
|
| totalPages | Yes | integer |
|
Response examples
Example status code responses for this method are shown here.
Paginated list of rules returned successfully.
{
"items": [
{
"id": "691ac85f91748d99a7db9a0c",
"name": "null1",
"description": "null",
"primaryMetricTypeId": "691ac85f96db0d33d60c5b51",
"enableAutoRun": false,
"targetAssetCount": 1,
"runStatus": {
"correlationId": "6ee12eee-42e9-4e8e-849c-c0fc0ea6bb8d",
"state": "Success",
"lastRunAt": "2025-11-24T11:44:14.140Z"
},
"targetAssetGroups": [
"691ac85fc73a235990285e05"
],
"dimensionId": "66ac9fe6091f80486b23249e",
"dimensionName": "Accuracy"
}
],
"pageSize": 10,
"currentPage": 1,
"totalItems": 2,
"totalPages": 1
}{
"type":"about:blank",
"title":"Bad Request",
"status":"400",
"detail":"Page number must be greater than or equal to 1",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules",
"errorCode":"DIS-QUALITY-RULES-USR-0001"
}{
"type":"about:blank",
"title":"Not Found",
"status":"404",
"detail":"No rules found for the given criteria",
"instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules",
"errorCode":"DIS-QUALITY-RULES-USR-0004"
}{
"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",
"errorCode":"DIS-QUALITY-RULES-SVC-0001"
}