Settings

Global DQ settings

Get global DQ settings

get

Returns the current value of all global DQ settings exposed on the public API.

Permissions

• Required: DATA_QUALITY

• Global bypass:

  • DATA_QUALITY and VIEW_PERMISSIONS_VIEW_ALL

  • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Responses

200

Settings retrieved successfully.

application/json

Current values of all global DQ settings exposed on the public API.

passingThresholdinteger · min: 1 · max: 100Required

Global passing score threshold. Scores at or above this value are considered passing (green). Must be greater than failingThreshold.

Example: 90

failingThresholdinteger · min: 1 · max: 100Required

Global failing score threshold. Scores below this value are considered failing (red). Must be less than passingThreshold.

Example: 75

lookbackLimitinteger · min: 1 · max: 30Required

Maximum number of historical rule runs used when computing DQ scores.

Example: 3

observationLimitinteger · min: 1 · max: 500Required

Maximum number of rows processed per rule execution.

Example: 500

previewLimitinteger · min: 1 · max: 500Required

Maximum number of results shown in the dataset overview and rule workbench. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

Example: 100

breakRecordsLimitinteger · min: 1 · max: 500Required

Maximum number of records returned when fetching break records for a rule. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

Example: 25

ruleRunTimeLimitinteger · min: 1 · max: 90Required

Maximum time in minutes a rule is allowed to run before it is automatically timed out.

Example: 30

jobLogRetentionHoursinteger · min: 24 · max: 720Required

Job log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

Example: 72

platformLogRetentionHoursinteger · min: 24 · max: 720Required

Platform log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

Example: 24

mapToPrimaryColumnbooleanRequired

When enabled, rules are automatically mapped to the primary column of the dataset.

Example: false

mandatoryPrimaryRuleColumnbooleanRequired

When enabled, a primary column must be set on every rule before it can be saved.

Example: false

mandatoryRuleDimensionbooleanRequired

When enabled, a dimension must be assigned to every rule before it can be saved.

Example: false

showDetailedExceptionbooleanRequired

When enabled, detailed exception stack traces are included in error responses. Recommended for non-production environments only.

Example: false

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/settings

HTTPcURLJavaScriptPython

GET /rest/dq/1.0/settings HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "passingThreshold": 90,
  "failingThreshold": 75,
  "lookbackLimit": 3,
  "observationLimit": 500,
  "previewLimit": 100,
  "breakRecordsLimit": 25,
  "ruleRunTimeLimit": 30,
  "jobLogRetentionHours": 72,
  "platformLogRetentionHours": 24,
  "mapToPrimaryColumn": false,
  "mandatoryPrimaryRuleColumn": false,
  "mandatoryRuleDimension": false,
  "showDetailedException": false
}

Update global DQ settings

patch

Partially update one or more global DQ settings. Only fields present in the request body are updated. Validation runs over all present fields before any update is persisted; if any field is invalid, the entire request is rejected with HTTP 400 and no settings are changed.

passingThreshold must be greater than failingThreshold. If both are sent in the same request and this constraint is violated, the request is rejected.

An empty request body ({}) is accepted and treated as a no-op: the current settings are returned unchanged.

Permissions

• Required: DATA_QUALITY and DATA_QUALITY_MANAGE_SETTINGS

• Global bypass:

  • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

Partial update for global DQ settings. Only fields present in the request body are updated; absent fields are left unchanged.

passingThresholdinteger · min: 1 · max: 100Optional

New value for the passingThreshold setting. Must be greater than failingThreshold.

failingThresholdinteger · min: 1 · max: 100Optional

New value for the failingThreshold setting. Must be less than passingThreshold.

lookbackLimitinteger · min: 1 · max: 30Optional

New value for the lookbackLimit setting.

observationLimitinteger · min: 1 · max: 500Optional

New value for the observationLimit setting.

previewLimitinteger · min: 1 · max: 500Optional

New value for the previewLimit setting. Recommended values are 25, 50, 100, 250, or 500. Other values are rounded to the closest recommended value.

breakRecordsLimitinteger · min: 1 · max: 500Optional

New value for the breakRecordsLimit setting. Recommended values are 25, 50, 100, 250, or 500. Other values are rounded to the closest recommended value.

ruleRunTimeLimitinteger · min: 1 · max: 90Optional

New value for the ruleRunTimeLimit setting.

jobLogRetentionHoursinteger · min: 24 · max: 720Optional

New value for the jobLogRetentionHours setting.

platformLogRetentionHoursinteger · min: 24 · max: 720Optional

New value for the platformLogRetentionHours setting.

mapToPrimaryColumnbooleanOptional

New value for the mapToPrimaryColumn setting.

mandatoryPrimaryRuleColumnbooleanOptional

New value for the mandatoryPrimaryRuleColumn setting.

mandatoryRuleDimensionbooleanOptional

New value for the mandatoryRuleDimension setting.

showDetailedExceptionbooleanOptional

New value for the showDetailedException setting.

Responses

200

Settings updated successfully. Returns the full current settings.

application/json

Current values of all global DQ settings exposed on the public API.

passingThresholdinteger · min: 1 · max: 100Required

Global passing score threshold. Scores at or above this value are considered passing (green). Must be greater than failingThreshold.

Example: 90

failingThresholdinteger · min: 1 · max: 100Required

Global failing score threshold. Scores below this value are considered failing (red). Must be less than passingThreshold.

Example: 75

lookbackLimitinteger · min: 1 · max: 30Required

Maximum number of historical rule runs used when computing DQ scores.

Example: 3

observationLimitinteger · min: 1 · max: 500Required

Maximum number of rows processed per rule execution.

Example: 500

previewLimitinteger · min: 1 · max: 500Required

Maximum number of results shown in the dataset overview and rule workbench. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

Example: 100

breakRecordsLimitinteger · min: 1 · max: 500Required

Maximum number of records returned when fetching break records for a rule. UI-only — does not affect what is stored. Recommended values are 25, 50, 100, 250, or 500. If a different value is provided, it is rounded to the closest recommended value.

Example: 25

ruleRunTimeLimitinteger · min: 1 · max: 90Required

Maximum time in minutes a rule is allowed to run before it is automatically timed out.

Example: 30

jobLogRetentionHoursinteger · min: 24 · max: 720Required

Job log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

Example: 72

platformLogRetentionHoursinteger · min: 24 · max: 720Required

Platform log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).

Example: 24

mapToPrimaryColumnbooleanRequired

When enabled, rules are automatically mapped to the primary column of the dataset.

Example: false

mandatoryPrimaryRuleColumnbooleanRequired

When enabled, a primary column must be set on every rule before it can be saved.

Example: false

mandatoryRuleDimensionbooleanRequired

When enabled, a dimension must be assigned to every rule before it can be saved.

Example: false

showDetailedExceptionbooleanRequired

When enabled, detailed exception stack traces are included in error responses. Recommended for non-production environments only.

Example: false

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

patch/settings

HTTPcURLJavaScriptPython

PATCH /rest/dq/1.0/settings HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "passingThreshold": 95,
  "failingThreshold": 80
}

Tighten passing and failing thresholdsSet log retention to 7 days for both logsEnable all governance enforcement settingsTurn on detailed exceptions for troubleshootingNo-op — returns current settings unchanged

{
  "passingThreshold": 95,
  "failingThreshold": 80,
  "lookbackLimit": 3,
  "observationLimit": 500,
  "previewLimit": 100,
  "breakRecordsLimit": 25,
  "ruleRunTimeLimit": 30,
  "jobLogRetentionHours": 72,
  "platformLogRetentionHours": 24,
  "mapToPrimaryColumn": false,
  "mandatoryPrimaryRuleColumn": false,
  "mandatoryRuleDimension": false,
  "showDetailedException": false
}