---
title: "Get rule by ID"
method: GET
path: "/v1/quality/rules/{ruleId}"
tags: ["Quality Rules"]
---

# Get rule by ID

`GET /v1/quality/rules/{ruleId}`

## Request

- Base URL: `https://api.cloud.precisely.com`
- URL: `https://api.cloud.precisely.com/v1/quality/rules/{ruleId}`
- Auth: HTTP bearer

Retrieves a rule and its configuration details by ID. Provides scoring bands, metric group info and last run status if available.

## Path parameters

- `ruleId` string, required

## Response `200`

Rule found and returned successfully

- RuleView: Represents a rule configuration and its execution status, including scoring bands and target asset information.
  - `captureFailedRecords` boolean
  - `createdBy` string
  - `createdDate` string, date-time
  - `customProperties` RuleCustomProperty[]: Custom metadata properties attached to this rule.
    - `name` string: The property name.
    - `value` unknown
  - `description` string
  - `dimensionId` string
  - `dimensionName` string
  - `enableAutoRun` boolean
  - `failedCondition` string
  - `filterCondition` string
  - `id` string
  - `isFailedCondition` boolean
  - `lastModifiedBy` string
  - `lastModifiedDate` string, date-time
  - `mappings` object[]
  - `name` string
  - `passCondition` string
  - `primaryMetricTypeId` string
  - `reconciliationStrategy` string: Reconciliation execution strategy (e.g. RUN_WITH_EXECUTION, COMPARE_RUN).
  - `ruleType` string
  - `runStatus` RunStatus: Represents the execution status of a rule, including correlation ID, state, and last run timestamp.
    - `correlationId` string
    - `lastRunAt` string, date-time
    - `state` string
  - `scoreBands` BandInfo[]
    - `color` string
    - `label` string
    - `minimumValue` number, double
  - `scoreClass` string: Score class the rule belongs to.
  - `scoreTarget` string: Identifier of the asset the rule is scored against.
  - `script` boolean
  - `supportingMetricTypeIds` string[]
  - `targetAssetCount` integer
  - `targetAssetGroups` string[]
  - `xref` string[]

## Other responses

- `400`: Invalid rule ID supplied
- `404`: Rule not found
- `500`: Internal server error

---

[API](https://skmtc.dev/precisely/apis/verify-api-portal.md) · [All operations](https://skmtc.dev/precisely/apis/verify-api-portal/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/verify-api-portal/revisions/380735465266?raw)