POST /v1/dataQuality/testCases

from metadata.sdk import configure
from metadata.sdk.entities import TestCases
from metadata.generated.schema.api.tests.createTestCase import CreateTestCaseRequest

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

# Create a column-level test case
request = CreateTestCaseRequest(
    name="column_value_max_to_be_between",
    testDefinition="columnValueMaxToBeBetween",
    testSuite="b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    entityLink="<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    parameterValues=[
        {"name": "minValueForMaxInCol", "value": "1"},
        {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    description="Validates shop_id max value stays between 1 and 100"
)

test_case = TestCases.create(request)
print(f"Created: {test_case.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.TestCases.*;

var testCase = TestCases.builder()
    .name("column_value_max_to_be_between")
    .testDefinition("columnValueMaxToBeBetween")
    .testSuite("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")
    .entityLink("<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>")
    .parameterValues(List.of(
        Map.of("name", "minValueForMaxInCol", "value", "1"),
        Map.of("name", "maxValueForMaxInCol", "value", "100")
    ))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testCases" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "column_value_max_to_be_between",
    "testDefinition": "columnValueMaxToBeBetween",
    "testSuite": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    "parameterValues": [
      {"name": "minValueForMaxInCol", "value": "1"},
      {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    "description": "Validates shop_id max value stays between 1 and 100"
  }'

{
  "id": "c1bce355-fa2f-48c6-ab4d-fad722a56ed7",
  "name": "column_value_max_to_be_between",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.dim_address.shop_id.column_value_max_to_be_between",
  "description": "Validates shop_id max value stays between 1 and 100",
  "version": 0.1,
  "updatedAt": 1769982759035,
  "updatedBy": "admin",
  "testDefinition": {
    "id": "def-id",
    "type": "testDefinition",
    "name": "columnValueMaxToBeBetween",
    "fullyQualifiedName": "columnValueMaxToBeBetween",
    "deleted": false
  },
  "testSuite": {
    "id": "suite-id",
    "type": "testSuite",
    "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "deleted": false
  },
  "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
  "parameterValues": [
    {"name": "minValueForMaxInCol", "value": "1"},
    {"name": "maxValueForMaxInCol", "value": "100"}
  ],
  "deleted": false,
  "owners": []
}

POST

dataQuality

testCases

POST /v1/dataQuality/testCases

from metadata.sdk import configure
from metadata.sdk.entities import TestCases
from metadata.generated.schema.api.tests.createTestCase import CreateTestCaseRequest

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

# Create a column-level test case
request = CreateTestCaseRequest(
    name="column_value_max_to_be_between",
    testDefinition="columnValueMaxToBeBetween",
    testSuite="b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    entityLink="<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    parameterValues=[
        {"name": "minValueForMaxInCol", "value": "1"},
        {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    description="Validates shop_id max value stays between 1 and 100"
)

test_case = TestCases.create(request)
print(f"Created: {test_case.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.TestCases.*;

var testCase = TestCases.builder()
    .name("column_value_max_to_be_between")
    .testDefinition("columnValueMaxToBeBetween")
    .testSuite("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")
    .entityLink("<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>")
    .parameterValues(List.of(
        Map.of("name", "minValueForMaxInCol", "value", "1"),
        Map.of("name", "maxValueForMaxInCol", "value", "100")
    ))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testCases" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "column_value_max_to_be_between",
    "testDefinition": "columnValueMaxToBeBetween",
    "testSuite": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    "parameterValues": [
      {"name": "minValueForMaxInCol", "value": "1"},
      {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    "description": "Validates shop_id max value stays between 1 and 100"
  }'

{
  "id": "c1bce355-fa2f-48c6-ab4d-fad722a56ed7",
  "name": "column_value_max_to_be_between",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.dim_address.shop_id.column_value_max_to_be_between",
  "description": "Validates shop_id max value stays between 1 and 100",
  "version": 0.1,
  "updatedAt": 1769982759035,
  "updatedBy": "admin",
  "testDefinition": {
    "id": "def-id",
    "type": "testDefinition",
    "name": "columnValueMaxToBeBetween",
    "fullyQualifiedName": "columnValueMaxToBeBetween",
    "deleted": false
  },
  "testSuite": {
    "id": "suite-id",
    "type": "testSuite",
    "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "deleted": false
  },
  "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
  "parameterValues": [
    {"name": "minValueForMaxInCol", "value": "1"},
    {"name": "maxValueForMaxInCol", "value": "100"}
  ],
  "deleted": false,
  "owners": []
}

Create a Test Case

Create a new test case by linking a test definition to a specific table or column with concrete parameter values.

Body Parameters

string

required

Name of the test case. Must be unique within the target entity scope.

string

required

Fully qualified name of the test definition to use (e.g., columnValueMaxToBeBetween).

string

required

Fully qualified name of the test suite this test case belongs to.

string

required

Entity link to the target table or column. Format: <#E::table::tableFQN> for table-level or <#E::table::tableFQN::columns::colName> for column-level.

array

Array of parameter name/value pairs as defined by the test definition.

Show properties

string

required

Name of the parameter (must match a parameter in the test definition).

string

required

Value for the parameter (always provided as a string).

string

Description of the test case in Markdown format.

array

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

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

string

Name of the owner entity.

POST /v1/dataQuality/testCases

from metadata.sdk import configure
from metadata.sdk.entities import TestCases
from metadata.generated.schema.api.tests.createTestCase import CreateTestCaseRequest

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

# Create a column-level test case
request = CreateTestCaseRequest(
    name="column_value_max_to_be_between",
    testDefinition="columnValueMaxToBeBetween",
    testSuite="b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    entityLink="<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    parameterValues=[
        {"name": "minValueForMaxInCol", "value": "1"},
        {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    description="Validates shop_id max value stays between 1 and 100"
)

test_case = TestCases.create(request)
print(f"Created: {test_case.fullyQualifiedName}")

import static org.openmetadata.sdk.fluent.TestCases.*;

var testCase = TestCases.builder()
    .name("column_value_max_to_be_between")
    .testDefinition("columnValueMaxToBeBetween")
    .testSuite("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")
    .entityLink("<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>")
    .parameterValues(List.of(
        Map.of("name", "minValueForMaxInCol", "value", "1"),
        Map.of("name", "maxValueForMaxInCol", "value", "100")
    ))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testCases" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "column_value_max_to_be_between",
    "testDefinition": "columnValueMaxToBeBetween",
    "testSuite": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
    "parameterValues": [
      {"name": "minValueForMaxInCol", "value": "1"},
      {"name": "maxValueForMaxInCol", "value": "100"}
    ],
    "description": "Validates shop_id max value stays between 1 and 100"
  }'

{
  "id": "c1bce355-fa2f-48c6-ab4d-fad722a56ed7",
  "name": "column_value_max_to_be_between",
  "fullyQualifiedName": "sample_data.ecommerce_db.shopify.dim_address.shop_id.column_value_max_to_be_between",
  "description": "Validates shop_id max value stays between 1 and 100",
  "version": 0.1,
  "updatedAt": 1769982759035,
  "updatedBy": "admin",
  "testDefinition": {
    "id": "def-id",
    "type": "testDefinition",
    "name": "columnValueMaxToBeBetween",
    "fullyQualifiedName": "columnValueMaxToBeBetween",
    "deleted": false
  },
  "testSuite": {
    "id": "suite-id",
    "type": "testSuite",
    "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
    "deleted": false
  },
  "entityLink": "<#E::table::sample_data.ecommerce_db.shopify.dim_address::columns::shop_id>",
  "parameterValues": [
    {"name": "minValueForMaxInCol", "value": "1"},
    {"name": "maxValueForMaxInCol", "value": "100"}
  ],
  "deleted": false,
  "owners": []
}

Returns

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

Response

string

Unique identifier for the test case (UUID format).

string

Test case name.

string

Fully qualified name in format table.column.testCaseName or table.testCaseName.

string

Description of the test case.

object

Reference to the test definition.

Show properties

string

UUID of the test definition.

string

Always testDefinition.

string

Name of the test definition.

string

FQN of the test definition.

object

Reference to the test suite.

Show properties

string

UUID of the test suite.

string

Always testSuite.

string

Name of the test suite.

string

Entity link to the target table or column.

array

Parameter values for this test case.

Show properties

string

Parameter name.

string

Parameter value.

array

List of owners assigned to the test case.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/dataQuality/testCases instead of POST to perform an upsert. If a test case with the same fullyQualifiedName already exists, it will be updated; otherwise, a new test case is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/dataQuality/testCases" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

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 cases
`409`	`ENTITY_ALREADY_EXISTS`	Test case with same name already exists for this entity (POST only)

List Test Cases

Retrieve a Test Case

⌘I

​Create a Test Case

​Body Parameters

​Returns

​Response

​Create or Update (PUT)

​Error Handling

Create a Test Case

Body Parameters

Returns

Response

Create or Update (PUT)

Error Handling