POST /v1/dataQuality/testSuites

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
from metadata.generated.schema.api.tests.createTestSuite import CreateTestSuiteRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Create a logical test suite
request = CreateTestSuiteRequest(
    name="critical_data_quality_checks",
    displayName="Critical Data Quality Checks",
    description="Groups all critical data quality test cases across production tables"
)

test_suite = TestSuites.create(request)
print(f"Created: {test_suite.name}")

import org.openmetadata.sdk.fluent.builders.TestSuiteBuilder;

// Create a logical test suite
// Use an initialized OpenMetadataClient named client.
var testSuite = new TestSuiteBuilder(client)
    .name("critical_data_quality_checks")
    .displayName("Critical Data Quality Checks")
    .description("Groups all critical data quality test cases across production tables")
    .create();

# Create a logical test suite
curl -X POST "{base_url}/api/v1/dataQuality/testSuites" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "critical_data_quality_checks",
    "displayName": "Critical Data Quality Checks",
    "description": "Groups all critical data quality test cases across production tables"
  }'

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "critical_data_quality_checks",
  "displayName": "Critical Data Quality Checks",
  "fullyQualifiedName": "critical_data_quality_checks",
  "description": "Groups all critical data quality test cases across production tables",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "basic": false
}

POST

dataQuality

testSuites

POST /v1/dataQuality/testSuites

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
from metadata.generated.schema.api.tests.createTestSuite import CreateTestSuiteRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Create a logical test suite
request = CreateTestSuiteRequest(
    name="critical_data_quality_checks",
    displayName="Critical Data Quality Checks",
    description="Groups all critical data quality test cases across production tables"
)

test_suite = TestSuites.create(request)
print(f"Created: {test_suite.name}")

import org.openmetadata.sdk.fluent.builders.TestSuiteBuilder;

// Create a logical test suite
// Use an initialized OpenMetadataClient named client.
var testSuite = new TestSuiteBuilder(client)
    .name("critical_data_quality_checks")
    .displayName("Critical Data Quality Checks")
    .description("Groups all critical data quality test cases across production tables")
    .create();

# Create a logical test suite
curl -X POST "{base_url}/api/v1/dataQuality/testSuites" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "critical_data_quality_checks",
    "displayName": "Critical Data Quality Checks",
    "description": "Groups all critical data quality test cases across production tables"
  }'

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "critical_data_quality_checks",
  "displayName": "Critical Data Quality Checks",
  "fullyQualifiedName": "critical_data_quality_checks",
  "description": "Groups all critical data quality test cases across production tables",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "basic": false
}

Create a Test Suite

POST /v1/dataQuality/testSuites creates a logical test suite that groups test cases across tables. To create a basic test suite linked to one table, use POST /v1/dataQuality/testSuites/basic as shown below. The endpoint determines the suite type. Omit executable and basic from the request body. basic is a response field set by the server. executable is deprecated.

Body Parameters

string

required

Name of the test suite. Must be unique. For a basic suite, the examples use <tableFQN>.testSuite, matching the server’s automatic naming convention.

string

Human-readable display name for the test suite.

string

Description of the test suite in Markdown format.

string

The fully qualified name (FQN) of an existing table. Required when creating a basic suite through /v1/dataQuality/testSuites/basic. Omit this field for logical suites.

array

Array of owner references (users or teams) to assign.

Show properties

string

UUID of the owner entity.

string

Owner entity type, such as user or team.

string

Name of the owner entity.

POST /v1/dataQuality/testSuites

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
from metadata.generated.schema.api.tests.createTestSuite import CreateTestSuiteRequest

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# Create a logical test suite
request = CreateTestSuiteRequest(
    name="critical_data_quality_checks",
    displayName="Critical Data Quality Checks",
    description="Groups all critical data quality test cases across production tables"
)

test_suite = TestSuites.create(request)
print(f"Created: {test_suite.name}")

import org.openmetadata.sdk.fluent.builders.TestSuiteBuilder;

// Create a logical test suite
// Use an initialized OpenMetadataClient named client.
var testSuite = new TestSuiteBuilder(client)
    .name("critical_data_quality_checks")
    .displayName("Critical Data Quality Checks")
    .description("Groups all critical data quality test cases across production tables")
    .create();

# Create a logical test suite
curl -X POST "{base_url}/api/v1/dataQuality/testSuites" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "critical_data_quality_checks",
    "displayName": "Critical Data Quality Checks",
    "description": "Groups all critical data quality test cases across production tables"
  }'

{
  "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
  "name": "critical_data_quality_checks",
  "displayName": "Critical Data Quality Checks",
  "fullyQualifiedName": "critical_data_quality_checks",
  "description": "Groups all critical data quality test cases across production tables",
  "version": 0.1,
  "updatedAt": 1769982757893,
  "updatedBy": "admin",
  "deleted": false,
  "owners": [],
  "basic": false
}

Returns

Returns the created test suite object with all specified properties and system-generated fields.

Response

string

Unique identifier for the test suite (UUID format).

string

Test suite name.

string

Fully qualified name of the test suite.

string

Human-readable display name.

string

Description of the test suite.

boolean

Whether this is a basic (true) or logical (false) test suite. Set by the server.

object

Reference to the table linked to a basic suite. Fields: id, type (table), name, and fullyQualifiedName. Not set for logical suites.

array

List of owners assigned to the test suite.

Show properties

string

UUID of the owner entity.

string

Owner entity type, such as user or team.

string

Name of the owner entity.

number

Version number for the entity (starts at 0.1).

Create a Basic Test Suite

The table must already exist in Collate. Use its FQN for basicEntityReference and <tableFQN>.testSuite for the suite name. If the table already has a basic suite, reuse it. Creating a test case automatically creates the table’s basic suite when one doesn’t exist.

curl -X POST "{base_url}/api/v1/dataQuality/testSuites/basic" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_data.ecommerce_db.shopify.dim_address.testSuite",
    "displayName": "Data Quality - dim_address",
    "description": "Basic test suite for dim_address",
    "basicEntityReference": "sample_data.ecommerce_db.shopify.dim_address"
  }'

The response has basic: true and a basicEntityReference object identifying the table.

Create or Update (PUT)

Use PUT /v1/dataQuality/testSuites for a logical suite, or PUT /v1/dataQuality/testSuites/basic for a basic suite, to perform an upsert. If a test suite with the same name already exists, the server updates it. Otherwise, the server creates a new test suite. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/dataQuality/testSuites" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "critical_data_quality_checks",
    "displayName": "Critical Data Quality Checks",
    "description": "Groups all critical data quality test cases across production tables"
  }'

PUT updates an existing entity instead of returning a 409 conflict error. Description, tags, owners, and custom properties follow field-level preserve and merge rules on PUT. These rules depend on the field and the calling user or bot’s permissions. Use PATCH to intentionally replace an existing value. For more information, see Entity Update Behavior (PUT vs PATCH).

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create test suites
`409`	`ENTITY_ALREADY_EXISTS`	Test suite with same name already exists (POST only)

​Create a Test Suite

​Body Parameters

​Returns

​Response

​Create a Basic Test Suite

​Create or Update (PUT)

​Error Handling

Create a Test Suite

Body Parameters

Returns

Response

Create a Basic Test Suite

Create or Update (PUT)

Error Handling