latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Data Quality Rules

Returns data quality rules matching the given search criteria.

Returns data quality rules matching the given search criteria. Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored. The returned data quality rules satisfy all constraints that are specified in this search criteria. By default a result containing 1000 data quality rules is returned.

get/dataQualityRules

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

namestring

The name of the dataquality rule to search for.

nameMatchMode'START' | 'END' | 'ANYWHERE' | 'EXACT'

The match mode used to compare <code>name</code>.

sortField'NAME'

The field that should be used as reference for sorting.

sortOrder'ASC' | 'DESC'

The order of sorting.

Response

The paged response with found DataQualityRule information.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.