DQ Rule API

The DQ Rule API allows you to manage dataset rules, rule breaks, and rule definitions.

Return a list of all rules and their details

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of DQ rules

application/json

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

500

Error fetching rules

application/json

get/v3/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"
  }
]

Create or update a rule for a given dataset

post

Creates or updates a rule for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dto.getDataset())

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

Responses

200

Rule upserted successfully

application/json

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

400

Error upserting rule

application/json

403

Forbidden. No access to dataset

application/json

post/v3/rules

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"
}

Copy rules from a source dataset and add them to a different target dataset

post

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)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

sourcestringRequired

Source dataset

Query parameters

targetstring[]Required

List of target dataset

Responses

200

Rules copied successfully to accessible target datasets

application/json

Rule Copy DTO

sourceDatasetstringRequired

Source dataset name

Example: datasetA

sourceRuleNamestringRequired

Source rule name

Example: exampleSourceRuleName

targetDatasetstringRequired

Target dataset name

Example: datasetB

generatedRuleNamestringOptional

Target rule name. Generated if not provided

Example: generatedTargetRuleName

400

Error copying rules from source to target datasets

application/json

403

Forbidden. No access to source dataset

application/json

post/v3/rules/{source}/copy

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"
  }
]

Return a list of rules for a dataset and/or rule

get

Returns a list of rules for a given dataset and/or rule name. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

ruleNamestringOptional

(Optional) Rule name. If not provided, all rules for the dataset will be returned

Responses

200

List of DQ rules

application/json

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

403

Forbidden. No access to dataset

application/json

get/v3/rules/{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"
  }
]

Create rules for a given dataset

post

Creates rules for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Bodyobject · RuleDTO[]

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

Responses

200

Rules created successfully

application/json

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

400

Dataset must be the same for all rules

application/json

403

Forbidden. No access to dataset

application/json

post/v3/rules/{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"
  }
]

Delete all rules for a given dataset

delete

Deletes all rules for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Responses

200

Rules deleted successfully

No content

400

Error deleting rules for the given dataset

application/json

403

Forbidden. No access to dataset

application/json

delete/v3/rules/{dataset}

DELETE /v3/rules/{dataset} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Validate the syntax of a Pushdown rule

post

Validates the syntax of a rule for a given Pushdown dataset, the rule value, and rule type. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

ruleValuestringRequired

Rule value

ruleTypestringRequired

Rule type

Responses

200

Rule syntax is correct

text/plain

400

Error validating rule

text/plain

403

Forbidden. No access to dataset

text/plain

post/v3/rules/{dataset}/validatePushdown

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.

Retrieve the pre-signed URL for rule break records for a given dataset

post

Retrieves the pre-signed URL for rule break records for a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

runDatestring · date-timeRequired

Run id

ruleNamestringRequired

Rule name

Example: exampleRuleName

archiveConnectionAliasstringRequired

Archive Connection alias

Responses

200

Presigned URL for RuleBreak records

text/plain

stringOptional

403

Forbidden. No access to dataset

text/plain

404

Archive Connection not found for alias

text/plain

post/v3/rules/{dataset}/presignedURLForRuleBreaks

POST /v3/rules/{dataset}/presignedURLForRuleBreaks?runDate=2026-07-12T01%3A30%3A48.876Z&ruleName=text&archiveConnectionAlias=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Returns the SQL results of a Pushdown rule

post

Return the SQL results of a rule for a given Pushdown dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset) and canAccessConnection(#connectionAlias)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

datasetstringRequired

Dataset name

connectionAliasstringRequired

Connection alias

ruleValuestringRequired

Rule value

ruleTypestringRequired

Rule type

Responses

200

Rule executed successfully

application/json

stringOptional

400

Error executing rule

application/json

403

Forbidden. No access to dataset or connection

application/json

post/v3/rules/run

POST /v3/rules/run?dataset=text&connectionAlias=text&ruleValue=text&ruleType=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Copy rules from a source dataset and add them to a different target dataset

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Bodyobject · RuleCopyDTO[]

Rule Copy DTO

sourceDatasetstringRequired

Source dataset name

Example: datasetA

sourceRuleNamestringRequired

Source rule name

Example: exampleSourceRuleName

targetDatasetstringRequired

Target dataset name

Example: datasetB

generatedRuleNamestringOptional

Target rule name. Generated if not provided

Example: generatedTargetRuleName

Responses

200

Rules copied successfully to the target dataset

application/json

Rule Copy DTO

sourceDatasetstringRequired

Source dataset name

Example: datasetA

sourceRuleNamestringRequired

Source rule name

Example: exampleSourceRuleName

targetDatasetstringRequired

Target dataset name

Example: datasetB

generatedRuleNamestringOptional

Target rule name. Generated if not provided

Example: generatedTargetRuleName

400

User does not have access to any source and target dataset pairs

application/json

post/v3/rules/copy

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"
  }
]

Retrieve a CSV file containing rule break records of a dataset

get

Retrieves a CSV file containing rule break records of a given dataset and rule. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

ruleNamestringRequired

Rule name

runIdstring · date-timeRequired

Run id

Query parameters

limitinteger · int32Optional

Limit number of records

Example: 100

Responses

200

RuleBreak records in CSV file format

application/octet-stream

string · binaryOptional

403

Forbidden. No access to dataset

application/octet-stream

404

Not found

application/octet-stream

get/v3/rules/{dataset}/{ruleName}/{runId}/breaks

GET /v3/rules/{dataset}/{ruleName}/{runId}/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Retrieve the SQL `SELECT` statement for rule break records of a dataset

get

Retrieves the SQL SELECT statement for rule break records of a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

tableNamestringRequired

Table name

storageTypestring · enumOptional

Storage type

Example: {"description":"Internal storage","value":"INTERNAL"}Possible values:

Responses

200

SQL SELECT statement for RuleBreak records

text/plain

stringOptional

403

Forbidden. No access to dataset

text/plain

get/v3/rules/{dataset}/ruleBreaksSelect

GET /v3/rules/{dataset}/ruleBreaksSelect?tableName=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

Retrieve the SQL `CREATE TABLE` statement for rule break records of a ataset

get

Retrieves the SQL CREATE TABLE statement for rule break records of a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

archiveConnectionAliasstringRequired

Archive Connection alias

runDatestring · date-timeOptional

Run id

ruleNamestringOptional

Rule name

Example: exampleRuleName

delimiterstringOptional

Delimiter

Default: ,Example: ,

Responses

200

SQL DDL statement for Rule Break records

text/plain

stringOptional

403

Forbidden. No access to dataset

text/plain

404

Archive Connection not found for alias

text/plain

get/v3/rules/{dataset}/ruleBreaksCreateTable

GET /v3/rules/{dataset}/ruleBreaksCreateTable?archiveConnectionAlias=text HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

text

List the rules of a dataset and/or run date

get

Returns a list of rules of a given dataset and/or run date. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

Query parameters

runDatestring · date-timeOptional

(Optional) Run id. If not provided, all rule breaks for the dataset will be returned

Responses

200

List of DQ rule breaks

application/json

datasetstringOptional

runIdstring · date-timeOptional

ruleNmstringOptional

linkIdstringOptional

403

Forbidden. No access to dataset

application/json

get/v3/rules/{dataset}/breaks

GET /v3/rules/{dataset}/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dataset": "text",
    "runId": "2026-07-12T01:30:48.876Z",
    "ruleNm": "text",
    "linkId": "text"
  }
]

List all rule definitions

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of RuleDefinitions

application/json

datasetstringRequired

ruleNmstring · max: 100RequiredPattern: ^[a-zA-Z0-9-_]+$

ruleTypestringRequired

ruleValuestringRequired

pointsinteger · int32Required

percnumber · doubleRequired

ruleRepostringRequired

isActiveinteger · int32Optional

userNmstringOptional

exceptionstringOptional

columnNamestringOptional

businessCategorystringOptional

businessDescstringOptional

dimIdinteger · int32Optional

dimNamestringOptional

ruleValueBuilderstringOptional

previewLimitinteger · int32Optional

runTimeLimitnumber · doubleOptional

scoringSchemeinteger · int32Optional

filterQuerystringOptional

dbNmstringOptional

tableNmstringOptional

500

Unable to fetch rule definitions

application/json

get/v3/rules/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"
  }
]

List the rule breaks of a Job ID or UUID

get

Return a list of rule breaks of a given job ID or UUID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

jobIdinteger · int32Optional

Job ID

jobUUIDstring · uuidOptional

Job UUID

Responses

200

List of DQ rule breaks

application/json

datasetstringOptional

runIdstring · date-timeOptional

ruleNmstringOptional

linkIdstringOptional

403

Forbidden. No access to dataset

application/json

404

Job not found

500

Error fetching rule breaks

application/json

get/v3/rules/breaks

GET /v3/rules/breaks HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "dataset": "text",
    "runId": "2026-07-12T01:30:48.876Z",
    "ruleNm": "text",
    "linkId": "text"
  }
]

Delete a rule from a given dataset

delete

Deletes a rule from a given dataset. Pre-authorization requirements:

hasDatasetAccess(#dataset)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

datasetstringRequired

Dataset name

ruleNamestringRequired

Rule name

Responses

200

Rule deleted successfully

No content

400

Error deleting rule by name for the given dataset

application/json

403

Forbidden. No access to dataset

application/json

delete/v3/rules/{dataset}/{ruleName}

DELETE /v3/rules/{dataset}/{ruleName} HTTP/1.1
Host: <host-name>
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 1 month ago

Was this helpful?