Test Cases

A Test Case is an instance of a test definition applied to a specific table or column with concrete parameter values. Test cases produce test results when executed.

A test case links a test definition (the validation logic) to a specific entity (table or column) via an entity link, with parameter values that configure the check.

Entity Link Format

Test cases reference their target entity using an entity link string:

Level	Format	Example
Table	`<#E::table::tableFQN>`	`<#E::table::sample_data.ecommerce_db.shopify.dim_address>`
Column	`<#E::table::tableFQN::columns::colName>`	`<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>`

Fully Qualified Name

The fully qualified name (FQN) format for a test case depends on the level:

# Table-level test case
sample_data.ecommerce_db.shopify.dim_address.testCaseName

# Column-level test case
sample_data.ecommerce_db.shopify.dim_address.shop_id.testCaseName

Test Case Lifecycle

The lifecycle has three steps:

Define a test case with a test definition, entity link, and parameter values.
Run the test through a test suite or manually to produce a result.
View test results with status (Success, Failed, Aborted) and result values.

API Endpoints

Method	Endpoint	Description
`POST`	`/v1/dataQuality/testCases`	Create a test case
`GET`	`/v1/dataQuality/testCases`	List test cases
`GET`	`/v1/dataQuality/testCases/{id}`	Get by ID
`GET`	`/v1/dataQuality/testCases/name/{fqn}`	Get by FQN
`PATCH`	`/v1/dataQuality/testCases/{id}`	Update by ID
`DELETE`	`/v1/dataQuality/testCases/{id}`	Delete by ID
`GET`	`/v1/dataQuality/testCases/{id}/versions`	List versions
`GET`	`/v1/dataQuality/testCases/testCaseResults/{fqn}`	Get test results
`POST`	`/v1/dataQuality/testCases/testCaseResults/{fqn}`	Add test result

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Test Cases

Test Cases

Entity Link Format

Fully Qualified Name

Test Case Lifecycle

API Endpoints

​Test Cases

​Entity Link Format

​Fully Qualified Name

​Test Case Lifecycle

​API Endpoints

Test Cases

Entity Link Format

Fully Qualified Name

Test Case Lifecycle

API Endpoints