GET /v1/dataQuality/testSuites
from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
suites = TestSuites.list(limit=50)
for ts in suites.data:
print(f"{ts.displayName} (executable: {ts.executable})")
# List all with auto-pagination
for ts in TestSuites.list_all():
print(f"{ts.fullyQualifiedName}")
# Filter by type
logical_suites = TestSuites.list(
testSuiteType="logical",
fields=["owners", "tests"],
limit=50
)
for ts in logical_suites.data:
print(f"{ts.displayName}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List first page
var result = TestSuites.list()
.limit(50)
.execute();
for (var ts : result.getData()) {
System.out.println(ts.getDisplayName());
}
// Filter by type
var result = TestSuites.list()
.testSuiteType("logical")
.fields("owners", "tests")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/dataQuality/testSuites?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by type
curl "{base_url}/api/v1/dataQuality/testSuites?testSuiteType=executable&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/dataQuality/testSuites?fields=owners,tests&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"displayName": "Data Contract - dim_address_comprehensive_contract",
"fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"version": 0.1,
"updatedAt": 1769982757893,
"updatedBy": "admin",
"deleted": false,
"owners": [],
"executable": true
}
],
"paging": {
"after": "...",
"total": 5
}
}
List Test Suites
List all test suites with optional filtering and pagination
GET
/
v1
/
dataQuality
/
testSuites
GET /v1/dataQuality/testSuites
from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
suites = TestSuites.list(limit=50)
for ts in suites.data:
print(f"{ts.displayName} (executable: {ts.executable})")
# List all with auto-pagination
for ts in TestSuites.list_all():
print(f"{ts.fullyQualifiedName}")
# Filter by type
logical_suites = TestSuites.list(
testSuiteType="logical",
fields=["owners", "tests"],
limit=50
)
for ts in logical_suites.data:
print(f"{ts.displayName}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List first page
var result = TestSuites.list()
.limit(50)
.execute();
for (var ts : result.getData()) {
System.out.println(ts.getDisplayName());
}
// Filter by type
var result = TestSuites.list()
.testSuiteType("logical")
.fields("owners", "tests")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/dataQuality/testSuites?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by type
curl "{base_url}/api/v1/dataQuality/testSuites?testSuiteType=executable&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/dataQuality/testSuites?fields=owners,tests&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"displayName": "Data Contract - dim_address_comprehensive_contract",
"fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"version": 0.1,
"updatedAt": 1769982757893,
"updatedBy": "admin",
"deleted": false,
"owners": [],
"executable": true
}
],
"paging": {
"after": "...",
"total": 5
}
}
List Test Suites
List all test suites with optional filtering and pagination.Query Parameters
Maximum number of results to return (max: 1000000).
Cursor for backward pagination.
Cursor for forward pagination.
Comma-separated list of fields to include:
owners, tests.Include
all, deleted, or non-deleted entities.Filter by test suite type:
executable or logical.GET /v1/dataQuality/testSuites
from metadata.sdk import configure
from metadata.sdk.entities import TestSuites
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List first page
suites = TestSuites.list(limit=50)
for ts in suites.data:
print(f"{ts.displayName} (executable: {ts.executable})")
# List all with auto-pagination
for ts in TestSuites.list_all():
print(f"{ts.fullyQualifiedName}")
# Filter by type
logical_suites = TestSuites.list(
testSuiteType="logical",
fields=["owners", "tests"],
limit=50
)
for ts in logical_suites.data:
print(f"{ts.displayName}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List first page
var result = TestSuites.list()
.limit(50)
.execute();
for (var ts : result.getData()) {
System.out.println(ts.getDisplayName());
}
// Filter by type
var result = TestSuites.list()
.testSuiteType("logical")
.fields("owners", "tests")
.limit(50)
.execute();
# List all
curl "{base_url}/api/v1/dataQuality/testSuites?limit=50" \
-H "Authorization: Bearer {access_token}"
# Filter by type
curl "{base_url}/api/v1/dataQuality/testSuites?testSuiteType=executable&limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/dataQuality/testSuites?fields=owners,tests&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"data": [
{
"id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"displayName": "Data Contract - dim_address_comprehensive_contract",
"fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
"version": 0.1,
"updatedAt": 1769982757893,
"updatedBy": "admin",
"deleted": false,
"owners": [],
"executable": true
}
],
"paging": {
"after": "...",
"total": 5
}
}
Returns
Returns a paginated list of test suite objects. Use thefields parameter to request additional data.
Response
Array of test suite objects.
Show properties
Show properties
Unique identifier for the test suite (UUID format).
Test suite name.
Fully qualified name of the test suite.
Human-readable display name.
Whether this is an executable or logical test suite.
List of owners. Only included when
fields contains owners.List of test case references. Only included when
fields contains tests.Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to list test suites |
Was this page helpful?
⌘I