Skip to main content

Test Suites

A Test Suite is a collection of test cases. Test suites come in two types:

Executable vs Logical

TypeexecutableDescription
ExecutabletrueAutomatically created and tied to a specific table. Contains all test cases for that table.
LogicalfalseUser-defined grouping of test cases across multiple tables for organized reporting.
Executable test suites are automatically created when you add the first test case to a table. Logical test suites are created manually to group related tests across tables.

Fully Qualified Name

The FQN for a test suite is its name:
b5fcae09-02c2-4c0b-8c4a-5b52d650e592

API Endpoints

MethodEndpointDescription
POST/v1/dataQuality/testSuitesCreate a test suite
GET/v1/dataQuality/testSuitesList test suites
GET/v1/dataQuality/testSuites/{id}Get by ID
GET/v1/dataQuality/testSuites/name/{fqn}Get by name
PATCH/v1/dataQuality/testSuites/{id}Update by ID
DELETE/v1/dataQuality/testSuites/{id}Delete by ID
GET/v1/dataQuality/testSuites/{id}/versionsList versions