Settings
Collibra REST API authentication using Basic Authentication.
Settings retrieved successfully.
Current values of all global DQ settings exposed on the public API.
Global passing score threshold. Scores at or above this value are considered passing (green). Must be greater than failingThreshold.
90Global failing score threshold. Scores below this value are considered failing (red). Must be less than passingThreshold.
75Maximum number of historical rule runs used when computing DQ scores.
3Maximum number of rows processed per rule execution.
500Maximum 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.
100Maximum 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.
25Maximum time in minutes a rule is allowed to run before it is automatically timed out.
30Job log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).
72Platform log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).
24When enabled, rules are automatically mapped to the primary column of the dataset.
falseWhen enabled, a primary column must be set on every rule before it can be saved.
falseWhen enabled, a dimension must be assigned to every rule before it can be saved.
falseWhen enabled, detailed exception stack traces are included in error responses. Recommended for non-production environments only.
falseUnauthorized
Forbidden
Internal Server Error
Collibra REST API authentication using Basic Authentication.
Partial update for global DQ settings. Only fields present in the request body are updated; absent fields are left unchanged.
New value for the passingThreshold setting. Must be greater than failingThreshold.
New value for the failingThreshold setting. Must be less than passingThreshold.
New value for the lookbackLimit setting.
New value for the observationLimit setting.
New value for the previewLimit setting. Recommended values are 25, 50, 100, 250, or 500. Other values are rounded to the closest recommended value.
New value for the breakRecordsLimit setting. Recommended values are 25, 50, 100, 250, or 500. Other values are rounded to the closest recommended value.
New value for the ruleRunTimeLimit setting.
New value for the jobLogRetentionHours setting.
New value for the platformLogRetentionHours setting.
New value for the mapToPrimaryColumn setting.
New value for the mandatoryPrimaryRuleColumn setting.
New value for the mandatoryRuleDimension setting.
New value for the showDetailedException setting.
Settings updated successfully. Returns the full current settings.
Current values of all global DQ settings exposed on the public API.
Global passing score threshold. Scores at or above this value are considered passing (green). Must be greater than failingThreshold.
90Global failing score threshold. Scores below this value are considered failing (red). Must be less than passingThreshold.
75Maximum number of historical rule runs used when computing DQ scores.
3Maximum number of rows processed per rule execution.
500Maximum 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.
100Maximum 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.
25Maximum time in minutes a rule is allowed to run before it is automatically timed out.
30Job log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).
72Platform log retention period in hours. Must be a multiple of 24 (minimum 1 day, maximum 30 days).
24When enabled, rules are automatically mapped to the primary column of the dataset.
falseWhen enabled, a primary column must be set on every rule before it can be saved.
falseWhen enabled, a dimension must be assigned to every rule before it can be saved.
falseWhen enabled, detailed exception stack traces are included in error responses. Recommended for non-production environments only.
falseBad Request
Unauthorized
Forbidden
Internal Server Error
Last updated
Was this helpful?