POST /v1/dataQuality/testDefinitions

from metadata.sdk import configure
from metadata.sdk.entities import TestDefinitions
from metadata.generated.schema.api.tests.createTestDefinition import CreateTestDefinitionRequest

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

request = CreateTestDefinitionRequest(
    name="columnValuesToMatchBusinessRule",
    displayName="Column Values To Match Business Rule",
    description="Validates that column values conform to a custom business rule regex pattern",
    entityType="COLUMN",
    testPlatforms=["OpenMetadata"],
    supportedDataTypes=["STRING", "VARCHAR", "TEXT"],
    parameterDefinition=[
        {
            "name": "regexPattern",
            "dataType": "STRING",
            "required": True,
            "description": "The regex pattern to match against"
        },
        {
            "name": "threshold",
            "dataType": "INT",
            "required": False,
            "description": "Maximum number of non-matching values allowed"
        }
    ]
)

test_def = TestDefinitions.create(request)
print(f"Created: {test_def.name}")

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

var testDef = TestDefinitions.builder()
    .name("columnValuesToMatchBusinessRule")
    .displayName("Column Values To Match Business Rule")
    .description("Validates that column values conform to a custom business rule regex pattern")
    .entityType("COLUMN")
    .testPlatforms(List.of("OpenMetadata"))
    .supportedDataTypes(List.of("STRING", "VARCHAR", "TEXT"))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testDefinitions" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "columnValuesToMatchBusinessRule",
    "displayName": "Column Values To Match Business Rule",
    "description": "Validates that column values conform to a custom business rule regex pattern",
    "entityType": "COLUMN",
    "testPlatforms": ["OpenMetadata"],
    "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
    "parameterDefinition": [
      {
        "name": "regexPattern",
        "dataType": "STRING",
        "required": true,
        "description": "The regex pattern to match against"
      },
      {
        "name": "threshold",
        "dataType": "INT",
        "required": false,
        "description": "Maximum number of non-matching values allowed"
      }
    ]
  }'

{
  "id": "b7c4e912-3a1f-4d6e-9c2b-8f5a7d3e1b4c",
  "name": "columnValuesToMatchBusinessRule",
  "displayName": "Column Values To Match Business Rule",
  "fullyQualifiedName": "columnValuesToMatchBusinessRule",
  "description": "Validates that column values conform to a custom business rule regex pattern",
  "version": 0.1,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "testPlatforms": ["OpenMetadata"],
  "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
  "parameterDefinition": [
    {
      "name": "regexPattern",
      "dataType": "STRING",
      "required": true,
      "description": "The regex pattern to match against"
    },
    {
      "name": "threshold",
      "dataType": "INT",
      "required": false,
      "description": "Maximum number of non-matching values allowed"
    }
  ],
  "entityType": "COLUMN",
  "provider": "user",
  "deleted": false
}

POST

dataQuality

testDefinitions

POST /v1/dataQuality/testDefinitions

from metadata.sdk import configure
from metadata.sdk.entities import TestDefinitions
from metadata.generated.schema.api.tests.createTestDefinition import CreateTestDefinitionRequest

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

request = CreateTestDefinitionRequest(
    name="columnValuesToMatchBusinessRule",
    displayName="Column Values To Match Business Rule",
    description="Validates that column values conform to a custom business rule regex pattern",
    entityType="COLUMN",
    testPlatforms=["OpenMetadata"],
    supportedDataTypes=["STRING", "VARCHAR", "TEXT"],
    parameterDefinition=[
        {
            "name": "regexPattern",
            "dataType": "STRING",
            "required": True,
            "description": "The regex pattern to match against"
        },
        {
            "name": "threshold",
            "dataType": "INT",
            "required": False,
            "description": "Maximum number of non-matching values allowed"
        }
    ]
)

test_def = TestDefinitions.create(request)
print(f"Created: {test_def.name}")

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

var testDef = TestDefinitions.builder()
    .name("columnValuesToMatchBusinessRule")
    .displayName("Column Values To Match Business Rule")
    .description("Validates that column values conform to a custom business rule regex pattern")
    .entityType("COLUMN")
    .testPlatforms(List.of("OpenMetadata"))
    .supportedDataTypes(List.of("STRING", "VARCHAR", "TEXT"))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testDefinitions" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "columnValuesToMatchBusinessRule",
    "displayName": "Column Values To Match Business Rule",
    "description": "Validates that column values conform to a custom business rule regex pattern",
    "entityType": "COLUMN",
    "testPlatforms": ["OpenMetadata"],
    "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
    "parameterDefinition": [
      {
        "name": "regexPattern",
        "dataType": "STRING",
        "required": true,
        "description": "The regex pattern to match against"
      },
      {
        "name": "threshold",
        "dataType": "INT",
        "required": false,
        "description": "Maximum number of non-matching values allowed"
      }
    ]
  }'

{
  "id": "b7c4e912-3a1f-4d6e-9c2b-8f5a7d3e1b4c",
  "name": "columnValuesToMatchBusinessRule",
  "displayName": "Column Values To Match Business Rule",
  "fullyQualifiedName": "columnValuesToMatchBusinessRule",
  "description": "Validates that column values conform to a custom business rule regex pattern",
  "version": 0.1,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "testPlatforms": ["OpenMetadata"],
  "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
  "parameterDefinition": [
    {
      "name": "regexPattern",
      "dataType": "STRING",
      "required": true,
      "description": "The regex pattern to match against"
    },
    {
      "name": "threshold",
      "dataType": "INT",
      "required": false,
      "description": "Maximum number of non-matching values allowed"
    }
  ],
  "entityType": "COLUMN",
  "provider": "user",
  "deleted": false
}

Create a Test Definition

Create a custom test definition to define organization-specific data quality validation logic.

Body Parameters

name

string

required

Name of the test definition. Must be unique across all test definitions.

displayName

string

Human-readable display name for the test definition.

description

string

Description of what this test validates, in Markdown format.

entityType

string

required

The entity type this test targets: TABLE or COLUMN.

testPlatforms

array

required

Array of supported test platforms. Typically ["OpenMetadata"].

supportedDataTypes

array

Array of data types this test can be applied to (e.g., STRING, INT, DOUBLE, VARCHAR, CHAR, TEXT, NUMBER, FLOAT, BOOLEAN). Only applicable when entityType is COLUMN.

parameterDefinition

array

Array of parameter definitions that this test accepts.

Show properties

name

string

required

Name of the parameter.

dataType

string

required

Data type of the parameter (e.g., INT, STRING, BOOLEAN, ARRAY, TABLE).

required

boolean

Whether this parameter is required when creating a test case. Defaults to false.

description

string

Description of the parameter.

owners

array

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

Show properties

string

UUID of the owner entity.

type

string

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

name

string

Name of the owner entity.

POST /v1/dataQuality/testDefinitions

from metadata.sdk import configure
from metadata.sdk.entities import TestDefinitions
from metadata.generated.schema.api.tests.createTestDefinition import CreateTestDefinitionRequest

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

request = CreateTestDefinitionRequest(
    name="columnValuesToMatchBusinessRule",
    displayName="Column Values To Match Business Rule",
    description="Validates that column values conform to a custom business rule regex pattern",
    entityType="COLUMN",
    testPlatforms=["OpenMetadata"],
    supportedDataTypes=["STRING", "VARCHAR", "TEXT"],
    parameterDefinition=[
        {
            "name": "regexPattern",
            "dataType": "STRING",
            "required": True,
            "description": "The regex pattern to match against"
        },
        {
            "name": "threshold",
            "dataType": "INT",
            "required": False,
            "description": "Maximum number of non-matching values allowed"
        }
    ]
)

test_def = TestDefinitions.create(request)
print(f"Created: {test_def.name}")

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

var testDef = TestDefinitions.builder()
    .name("columnValuesToMatchBusinessRule")
    .displayName("Column Values To Match Business Rule")
    .description("Validates that column values conform to a custom business rule regex pattern")
    .entityType("COLUMN")
    .testPlatforms(List.of("OpenMetadata"))
    .supportedDataTypes(List.of("STRING", "VARCHAR", "TEXT"))
    .create();

curl -X POST "{base_url}/api/v1/dataQuality/testDefinitions" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "columnValuesToMatchBusinessRule",
    "displayName": "Column Values To Match Business Rule",
    "description": "Validates that column values conform to a custom business rule regex pattern",
    "entityType": "COLUMN",
    "testPlatforms": ["OpenMetadata"],
    "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
    "parameterDefinition": [
      {
        "name": "regexPattern",
        "dataType": "STRING",
        "required": true,
        "description": "The regex pattern to match against"
      },
      {
        "name": "threshold",
        "dataType": "INT",
        "required": false,
        "description": "Maximum number of non-matching values allowed"
      }
    ]
  }'

{
  "id": "b7c4e912-3a1f-4d6e-9c2b-8f5a7d3e1b4c",
  "name": "columnValuesToMatchBusinessRule",
  "displayName": "Column Values To Match Business Rule",
  "fullyQualifiedName": "columnValuesToMatchBusinessRule",
  "description": "Validates that column values conform to a custom business rule regex pattern",
  "version": 0.1,
  "updatedAt": 1769982700000,
  "updatedBy": "admin",
  "testPlatforms": ["OpenMetadata"],
  "supportedDataTypes": ["STRING", "VARCHAR", "TEXT"],
  "parameterDefinition": [
    {
      "name": "regexPattern",
      "dataType": "STRING",
      "required": true,
      "description": "The regex pattern to match against"
    },
    {
      "name": "threshold",
      "dataType": "INT",
      "required": false,
      "description": "Maximum number of non-matching values allowed"
    }
  ],
  "entityType": "COLUMN",
  "provider": "user",
  "deleted": false
}

Returns

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

Response

string

Unique identifier for the test definition (UUID format).

name

string

Test definition name.

fullyQualifiedName

string

Fully qualified name (same as name for test definitions).

displayName

string

Human-readable display name.

description

string

Description of what the test validates.

entityType

string

Target entity type: TABLE or COLUMN.

testPlatforms

array

Supported test platforms.

supportedDataTypes

array

Data types this test can be applied to.

parameterDefinition

array

Parameters accepted by this test definition.

Show properties

name

string

Parameter name.

dataType

string

Data type of the parameter.

required

boolean

Whether this parameter is required.

description

string

Description of the parameter.

provider

string

Always user for custom test definitions.

version

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

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

curl -X PUT "{base_url}/api/v1/dataQuality/testDefinitions" \
  -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.

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 definitions
`409`	`ENTITY_ALREADY_EXISTS`	Test definition with same name already exists (POST only)

Test Definitions

List Test Definitions

​Create a Test Definition

​Body Parameters

​Returns

​Response

​Create or Update (PUT)

​Error Handling

Create a Test Definition

Body Parameters

Returns

Response

Create or Update (PUT)

Error Handling