Get rule status or filter by asset ID - Precisely Data Integrity Suite

Data Integrity Suite APIs

Product
Data_Integrity
Spatial_Analytics
Data_Enrichment
geo_addressing_1
Services
Spatial Analytics
Data Enrichment
Geo Addressing
ft:title
Data Integrity Suite APIs
ft:locale
en-US
PublicationType
pt_developer
copyrightfirst
2023
copyrightlast
2026

Fetches the rule execution status along with asset information.

HTML

GET https://hostname/v1/quality/rules/{ruleId}/jobs

Request

Path parameters

Key Required Type Description
ruleId Yes string

ID of the rule to retrieve.

Query parameters

Key Required Type Description
assetId No string The Asset ID.
page No integer The page number.
limit No integer The number of items per page.

Response

The successful response returns the rule execution status along with asset information.

Response body properties

Ancestors Property Required Type Description
  id Yes string The ID of the rule for the retrieved execution status.
  primaryMetricTypeId Yes string  
  name Yes string  
  runStatus Yes object Provides the execution status of a rule, including correlation ID, state, and last run timestamp.
runStatus correlationId Yes string  
runStatus state Yes string  
runStatus lastRunAt Yes string  
  errorDetails Yes array[object]  
  ruleAssetView Yes object Pagination wrapper for paginated API responses containing a list of items and pagination metadata.
ruleAssetView items Yes array[object]  
ruleAssetView/items assetName Yes string  
ruleAssetView/items assetPath Yes string  
ruleAssetView/items assetId Yes string  
ruleAssetView/items parentAssetId Yes string  
ruleAssetView/items score Yes integer  
ruleAssetView/items passCount Yes integer  
ruleAssetView/items totalCount Yes integer  
ruleAssetView/items failCount Yes integer  
ruleAssetView/items evaluateCount Yes integer  
ruleAssetView/items capturedFailedRecords Yes boolean  
ruleAssetView/items isSampleAvailable Yes boolean  
ruleAssetView/items catalogType Yes string  
ruleAssetView/items lastRunAt Yes string  
ruleAssetView/items scoreBands Yes array  
ruleAssetView/items/scoreBands label Yes string  
ruleAssetView/items/scoreBands color Yes string  
ruleAssetView/items/scoreBands minimumValue Yes string  
ruleAssetView totalPages Yes integer Total number of pages available based on page size and total items.
ruleAssetView totalItems Yes integer Total number of items across all pages.
ruleAssetView currentPage Yes integer Current page number.
ruleAssetView pageSize Yes integer Number of items per page.

Response examples

Example status code responses for this method are shown here.

Examples

Rule found and execution status returned successfully.

{
  "id": "6944e5800e3000e0588d3659",
  "primaryMetricTypeId": "6944e5800e3000e0588d3656",
  "name": "8229_Dataset_1",
  "runStatus": {
    "correlationId": "893087b0-3e3e-4630-93bd-bd1f9c3a3491",
    "state": "Success",
    "lastRunAt": "2025-12-19T05:48:05.909Z"
  },
  "errorDetails": [],
  "ruleAssetView": {
    "items": [
      {
        "assetName": "customer_info",
        "assetPath": "Databricks_Automationdb > kt_metastore > test_freshness > customer_info",
        "assetId": "6944e48e749df0beee68331b",
        "parentAssetId": "6944e48e749df0beee683319",
        "score": 0,
        "passCount": 0,
        "totalCount": 3,
        "failCount": 0,
        "evaluateCount": 0,
        "capturedFailedRecords": true,
        "isSampleAvailable": false,
        "catalogType": "Dataset",
        "lastRunAt": "2025-12-19T05:48:00.311Z",
        "scoreBands": {
          "label": "Poor",
          "color": "red",
          "minimumValue": 0
        }
      }
    ],
    "totalPages": 1,
    "totalItems": 1,
    "currentPage": 1,
    "pageSize": 10
  }
}
{
   "type":"about:blank",
   "title":"Bad Request",
   "status":"400",
   "detail":"Invalid or malformed request",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/jobs",
   "errorCode":"DIS-QUALITY-RULES-USR-2003"
}
{
   "type":"about:blank",
   "title":"Not Found",
   "status":"404",
   "detail":"Rule not found for given ID",
   "instance":"https://verify-api-portal-dev.dqcore.cloud.precisely.services/v1/quality/rules/689d9917437bd1d494d6b/jobs",
   "errorCode":"DIS-QUALITY-RULES-USR-0003"
}
{
   "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/jobs",
   "errorCode":"DIS-QUALITY-RULES-SVC-0001"
}