from metadata.sdk import configurefrom metadata.sdk.entities import TestDefinitionsconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pagedefinitions = TestDefinitions.list(limit=50)for td in definitions.entities: print(f"{td.name.root} ({td.entityType.value})")# List all with auto-paginationfor td in TestDefinitions.list_all(): print(f"{td.name.root}: {td.description.root}")# Filter by entity typecolumn_defs = TestDefinitions.list( filters={"entityType": "COLUMN"}, fields=["owners"], limit=50)for td in column_defs.entities: print(f"{td.name.root} - supports: {td.supportedDataTypes}")
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.testDefinitions().list(params);for (var item : page.getData()) { System.out.println(item.getName());}// Filter by entity typevar filtered = new ListParams() .addFilter("entityType", "COLUMN") .setLimit(50);var filteredPage = client.testDefinitions().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getName());}
# List allcurl "{base_url}/api/v1/dataQuality/testDefinitions?limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by entity typecurl "{base_url}/api/v1/dataQuality/testDefinitions?entityType=COLUMN&limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by supported data typecurl "{base_url}/api/v1/dataQuality/testDefinitions?supportedDataType=STRING&limit=50" \ -H "Authorization: Bearer {access_token}"
{ "data": [ { "id": "a636d153-f1e8-45be-86d3-52aa6b71730d", "name": "columnValueLengthsToBeBetween", "displayName": "Column Value Lengths To Be Between", "fullyQualifiedName": "columnValueLengthsToBeBetween", "description": "This test definition validates that the lengths of column values are between a specified range...", "version": 0.1, "updatedAt": 1769982618104, "updatedBy": "admin", "testPlatforms": ["OpenMetadata"], "supportedDataTypes": ["STRING", "VARCHAR", "CHAR", "TEXT"], "parameterDefinition": [ { "name": "minLength", "dataType": "INT", "required": false, "description": "The min length" }, { "name": "maxLength", "dataType": "INT", "required": false, "description": "The max length" } ], "entityType": "COLUMN", "provider": "system", "deleted": false } ], "paging": { "after": "...", "total": 25 }}
List Test Definitions
List all test definitions with optional filtering and pagination
GET
/
v1
/
dataQuality
/
testDefinitions
GET /v1/dataQuality/testDefinitions
from metadata.sdk import configurefrom metadata.sdk.entities import TestDefinitionsconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pagedefinitions = TestDefinitions.list(limit=50)for td in definitions.entities: print(f"{td.name.root} ({td.entityType.value})")# List all with auto-paginationfor td in TestDefinitions.list_all(): print(f"{td.name.root}: {td.description.root}")# Filter by entity typecolumn_defs = TestDefinitions.list( filters={"entityType": "COLUMN"}, fields=["owners"], limit=50)for td in column_defs.entities: print(f"{td.name.root} - supports: {td.supportedDataTypes}")
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.testDefinitions().list(params);for (var item : page.getData()) { System.out.println(item.getName());}// Filter by entity typevar filtered = new ListParams() .addFilter("entityType", "COLUMN") .setLimit(50);var filteredPage = client.testDefinitions().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getName());}
# List allcurl "{base_url}/api/v1/dataQuality/testDefinitions?limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by entity typecurl "{base_url}/api/v1/dataQuality/testDefinitions?entityType=COLUMN&limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by supported data typecurl "{base_url}/api/v1/dataQuality/testDefinitions?supportedDataType=STRING&limit=50" \ -H "Authorization: Bearer {access_token}"
{ "data": [ { "id": "a636d153-f1e8-45be-86d3-52aa6b71730d", "name": "columnValueLengthsToBeBetween", "displayName": "Column Value Lengths To Be Between", "fullyQualifiedName": "columnValueLengthsToBeBetween", "description": "This test definition validates that the lengths of column values are between a specified range...", "version": 0.1, "updatedAt": 1769982618104, "updatedBy": "admin", "testPlatforms": ["OpenMetadata"], "supportedDataTypes": ["STRING", "VARCHAR", "CHAR", "TEXT"], "parameterDefinition": [ { "name": "minLength", "dataType": "INT", "required": false, "description": "The min length" }, { "name": "maxLength", "dataType": "INT", "required": false, "description": "The max length" } ], "entityType": "COLUMN", "provider": "system", "deleted": false } ], "paging": { "after": "...", "total": 25 }}
List Test Definitions
List all test definitions with optional filtering and pagination.
Query Parameters
integer
default:"10"
Maximum number of results to return (max: 1000000).
string
Cursor for backward pagination.
string
Cursor for forward pagination.
string
Comma-separated list of fields to include: owners.
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
string
Filter by test platform, for example OpenMetadata.
string
Filter by entity type: TABLE or COLUMN.
string
Filter by supported data type, for example STRING, INT, DOUBLE.
GET /v1/dataQuality/testDefinitions
from metadata.sdk import configurefrom metadata.sdk.entities import TestDefinitionsconfigure( host="https://your-company.open-metadata.org/api", jwt_token="your-jwt-token")# List first pagedefinitions = TestDefinitions.list(limit=50)for td in definitions.entities: print(f"{td.name.root} ({td.entityType.value})")# List all with auto-paginationfor td in TestDefinitions.list_all(): print(f"{td.name.root}: {td.description.root}")# Filter by entity typecolumn_defs = TestDefinitions.list( filters={"entityType": "COLUMN"}, fields=["owners"], limit=50)for td in column_defs.entities: print(f"{td.name.root} - supports: {td.supportedDataTypes}")
import org.openmetadata.sdk.models.ListParams;// client is an initialized OpenMetadataClient.// List first pagevar params = new ListParams().setLimit(50);var page = client.testDefinitions().list(params);for (var item : page.getData()) { System.out.println(item.getName());}// Filter by entity typevar filtered = new ListParams() .addFilter("entityType", "COLUMN") .setLimit(50);var filteredPage = client.testDefinitions().list(filtered);for (var item : filteredPage.getData()) { System.out.println(item.getName());}
# List allcurl "{base_url}/api/v1/dataQuality/testDefinitions?limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by entity typecurl "{base_url}/api/v1/dataQuality/testDefinitions?entityType=COLUMN&limit=50" \ -H "Authorization: Bearer {access_token}"# Filter by supported data typecurl "{base_url}/api/v1/dataQuality/testDefinitions?supportedDataType=STRING&limit=50" \ -H "Authorization: Bearer {access_token}"
{ "data": [ { "id": "a636d153-f1e8-45be-86d3-52aa6b71730d", "name": "columnValueLengthsToBeBetween", "displayName": "Column Value Lengths To Be Between", "fullyQualifiedName": "columnValueLengthsToBeBetween", "description": "This test definition validates that the lengths of column values are between a specified range...", "version": 0.1, "updatedAt": 1769982618104, "updatedBy": "admin", "testPlatforms": ["OpenMetadata"], "supportedDataTypes": ["STRING", "VARCHAR", "CHAR", "TEXT"], "parameterDefinition": [ { "name": "minLength", "dataType": "INT", "required": false, "description": "The min length" }, { "name": "maxLength", "dataType": "INT", "required": false, "description": "The max length" } ], "entityType": "COLUMN", "provider": "system", "deleted": false } ], "paging": { "after": "...", "total": 25 }}
Returns
Returns a paginated list of test definition objects. Use the fields parameter to request additional data.
Response
array
Array of test definition objects.
Show properties
string
Unique identifier for the test definition (UUID format).
string
Test definition name.
string
Fully qualified name (same as name for test definitions).
string
Human-readable display name.
string
Description of what the test validates.
string
Target entity type: TABLE or COLUMN.
array
Supported test platforms, for example OpenMetadata.
array
Data types this test can be applied to.
array
Parameters accepted by this test definition.
Show properties
string
Parameter name.
string
Data type of the parameter, for example INT, STRING, BOOLEAN.
boolean
Whether this parameter is required.
string
Description of the parameter.
string
Whether the definition is system (built-in) or user (custom).
array
List of owners. Only included when fields contains owners.
object
Pagination information.
Show properties
integer
Total count of test definitions matching the query.