Quality Rules

Get rule by ID

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

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

Path parameters

ruleIdstring required

ID of the rule to retrieve

Response

Rule found and returned successfully

captureFailedRecordsboolean
createdBystring
createdDatestring date-time
descriptionstring
dimensionIdstring
dimensionNamestring
enableAutoRunboolean
failedConditionstring
filterConditionstring
idstring
isFailedConditionboolean
lastModifiedBystring
lastModifiedDatestring date-time
mappingsobject[]
namestring
passConditionstring
primaryMetricTypeIdstring
reconciliationStrategystring

Reconciliation execution strategy (e.g. RUN_WITH_EXECUTION, COMPARE_RUN).

ruleTypestring
scoreClassstring

Score class the rule belongs to.

scoreTargetstring

Identifier of the asset the rule is scored against.

scriptboolean
supportingMetricTypeIdsstring[]
targetAssetCountinteger
targetAssetGroupsstring[]
xrefstring[]

Example response

{
  "scoreClass": "Quality"
}

Changes

No recorded changes to this operation across all 1 revision of this API.