For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

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
post/v3/rules

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
post/v3/rules/{source}/copy

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

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

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

delete/v3/rules/{dataset}

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
post/v3/rules/{dataset}/validatePushdown

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
post/v3/rules/{dataset}/presignedURLForRuleBreaks

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
post/v3/rules/run

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
post/v3/rules/copy

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
get/v3/rules/{dataset}/{ruleName}/{runId}/breaks

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
get/v3/rules/{dataset}/ruleBreaksSelect

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
get/v3/rules/{dataset}/ruleBreaksCreateTable

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
get/v3/rules/{dataset}/breaks

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
get/v3/rules/definitions

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
get/v3/rules/breaks

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

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

No content

Last updated

Was this helpful?