Skip to main content

​
Data Quality

The Data Quality APIs allow you to define, organize, and execute data quality checks across your data assets. The API is organized around three core entities.

​
Core Entities

Test Definitions

Define the logic of a data quality check — what to validate and what parameters it accepts.

Test Suites

Group test cases into executable or logical collections for organized testing.

Test Cases

Instances of test definitions applied to specific tables and columns with concrete parameter values.

​
How They Relate

TestDefinition (the "what to check")
    └── TestCase (an instance applied to a specific entity)
            └── TestSuite (a grouping of test cases)
  • A Test Definition describes a reusable validation rule (e.g., “column values must be between X and Y”). OpenMetadata ships with 25+ built-in definitions, and you can create custom ones.
  • A Test Case applies a test definition to a specific table or column, providing concrete parameter values (e.g., minValue=0, maxValue=100).
  • A Test Suite groups test cases together. Executable test suites are tied to a single table and run automatically. Logical test suites are user-defined groupings across tables.

​
Base URL

All Data Quality endpoints are under: 
/v1/dataQuality/