DQ Rule API
The DQ Rule API allows you to manage dataset rules, rule breaks, and rule definitions.
Returns a list of all dataset rules and their details. Admin (ROLE_ADMIN) users can access all dataset rules and users without the admin role can only view rules on datasets to which they have dataset access.
List of DQ rules
^[a-zA-Z0-9-_]+$Error fetching rules
GET /v3/rules HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}
]Creates or updates a rule for a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dto.getDataset())
^[a-zA-Z0-9-_]+$Rule upserted successfully
^[a-zA-Z0-9-_]+$Error upserting rule
Forbidden. No access to dataset
POST /v3/rules HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 351
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}Copies rules from a source dataset and adds them to a different target dataset. Note: You must have access to both datasets to copy rules successfully. Pre-authorization requirements:
hasDatasetAccess(#sourceDataset)
Source dataset
List of target dataset
Rules copied successfully to accessible target datasets
Rule Copy DTO
Source dataset name
datasetASource rule name
exampleSourceRuleNameTarget dataset name
datasetBTarget rule name. Generated if not provided
generatedTargetRuleNameError copying rules from source to target datasets
Forbidden. No access to source dataset
POST /v3/rules/{source}/copy?target=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"sourceDataset": "datasetA",
"sourceRuleName": "exampleSourceRuleName",
"targetDataset": "datasetB",
"generatedRuleName": "generatedTargetRuleName"
}
]Returns a list of rules for a given dataset and/or rule name. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
(Optional) Rule name. If not provided, all rules for the dataset will be returned
List of DQ rules
^[a-zA-Z0-9-_]+$Forbidden. No access to dataset
GET /v3/rules/{dataset} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}
]Creates rules for a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
^[a-zA-Z0-9-_]+$Rules created successfully
^[a-zA-Z0-9-_]+$Dataset must be the same for all rules
Forbidden. No access to dataset
POST /v3/rules/{dataset} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 353
[
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}
][
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text"
}
]Deletes all rules for a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Rules deleted successfully
No content
Error deleting rules for the given dataset
Forbidden. No access to dataset
DELETE /v3/rules/{dataset} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Validates the syntax of a rule for a given Pushdown dataset, the rule value, and rule type. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Rule value
Rule type
Rule syntax is correct
Error validating rule
Forbidden. No access to dataset
POST /v3/rules/{dataset}/validatePushdown?ruleValue=text&ruleType=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Syntax of rule <ruleValue> is correct.Retrieves the pre-signed URL for rule break records for a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Run id
Rule name
exampleRuleNameArchive Connection alias
Presigned URL for RuleBreak records
Forbidden. No access to dataset
Archive Connection not found for alias
POST /v3/rules/{dataset}/presignedURLForRuleBreaks?runDate=2026-01-01T00%3A00%3A00.000Z&ruleName=text&archiveConnectionAlias=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textReturn the SQL results of a rule for a given Pushdown dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset) and canAccessConnection(#connectionAlias)
Dataset name
Connection alias
Rule value
Rule type
Rule executed successfully
Error executing rule
Forbidden. No access to dataset or connection
POST /v3/rules/run?dataset=text&connectionAlias=text&ruleValue=text&ruleType=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textCopies rules from a source dataset and adds them to a different target dataset.Note: You must have access to both datasets to copy rules successfully
Rule Copy DTO
Source dataset name
datasetASource rule name
exampleSourceRuleNameTarget dataset name
datasetBTarget rule name. Generated if not provided
generatedTargetRuleNameRules copied successfully to the target dataset
Rule Copy DTO
Source dataset name
datasetASource rule name
exampleSourceRuleNameTarget dataset name
datasetBTarget rule name. Generated if not provided
generatedTargetRuleNameUser does not have access to any source and target dataset pairs
POST /v3/rules/copy HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 144
[
{
"sourceDataset": "datasetA",
"sourceRuleName": "exampleSourceRuleName",
"targetDataset": "datasetB",
"generatedRuleName": "generatedTargetRuleName"
}
][
{
"sourceDataset": "datasetA",
"sourceRuleName": "exampleSourceRuleName",
"targetDataset": "datasetB",
"generatedRuleName": "generatedTargetRuleName"
}
]Retrieves a CSV file containing rule break records of a given dataset and rule. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Rule name
Run id
Limit number of records
100RuleBreak records in CSV file format
Forbidden. No access to dataset
Not found
GET /v3/rules/{dataset}/{ruleName}/{runId}/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
binaryRetrieves the SQL SELECT statement for rule break records of a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Table name
Storage type
{"description":"Internal storage","value":"INTERNAL"}Possible values: SQL SELECT statement for RuleBreak records
Forbidden. No access to dataset
GET /v3/rules/{dataset}/ruleBreaksSelect?tableName=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textRetrieves the SQL CREATE TABLE statement for rule break records of a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Archive Connection alias
Run id
Rule name
exampleRuleNameDelimiter
,Example: ,SQL DDL statement for Rule Break records
Forbidden. No access to dataset
Archive Connection not found for alias
GET /v3/rules/{dataset}/ruleBreaksCreateTable?archiveConnectionAlias=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
textReturns a list of rules of a given dataset and/or run date. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
(Optional) Run id. If not provided, all rule breaks for the dataset will be returned
List of DQ rule breaks
Forbidden. No access to dataset
GET /v3/rules/{dataset}/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"dataset": "text",
"runId": "2026-01-01T00:00:00.000Z",
"ruleNm": "text",
"linkId": "text"
}
]Returns a list of all rule definitions. Admin (ROLE_ADMIN) users can access all dataset rules and users without the admin role can only view rules on datasets to which they have dataset access.
List of RuleDefinitions
^[a-zA-Z0-9-_]+$Unable to fetch rule definitions
GET /v3/rules/definitions HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"dataset": "text",
"ruleNm": "text",
"ruleType": "text",
"ruleValue": "text",
"points": 1,
"perc": 1,
"ruleRepo": "text",
"isActive": 1,
"userNm": "text",
"exception": "text",
"columnName": "text",
"businessCategory": "text",
"businessDesc": "text",
"dimId": 1,
"dimName": "text",
"ruleValueBuilder": "text",
"previewLimit": 1,
"runTimeLimit": 1,
"scoringScheme": 1,
"filterQuery": "text",
"dbNm": "text",
"tableNm": "text"
}
]Return a list of rule breaks of a given job ID or UUID.
Job ID
Job UUID
List of DQ rule breaks
Forbidden. No access to dataset
Job not found
Error fetching rule breaks
GET /v3/rules/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
{
"dataset": "text",
"runId": "2026-01-01T00:00:00.000Z",
"ruleNm": "text",
"linkId": "text"
}
]Deletes a rule from a given dataset. Pre-authorization requirements:
hasDatasetAccess(#dataset)
Dataset name
Rule name
Rule deleted successfully
No content
Error deleting rule by name for the given dataset
Forbidden. No access to dataset
DELETE /v3/rules/{dataset}/{ruleName} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?