GET /v1/dataQuality/testSuites/{id}/versions
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 all versions
versions = TestSuites.get_versions("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
for v in versions:
print(f"Version {v.version}: {v.description}")
# Get a specific version
ts_v1 = TestSuites.get_specific_version(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"0.1"
)
print(f"Original description: {ts_v1.description}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List all versions
var history = TestSuites.getVersions("e86a9a11-852f-4bac-b5a7-993b2bbbb572");
for (var version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
var v1 = TestSuites.getSpecificVersion(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
0.1
);
# List all versions
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "testSuite",
"versions": [
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.2,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"description\":\"Updated description\",\"executable\":true}",
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.1,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"executable\":true}"
]
}
Test Suite Versions
List and retrieve historical versions of a test suite
GET
/
v1
/
dataQuality
/
testSuites
/
{id}
/
versions
GET /v1/dataQuality/testSuites/{id}/versions
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 all versions
versions = TestSuites.get_versions("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
for v in versions:
print(f"Version {v.version}: {v.description}")
# Get a specific version
ts_v1 = TestSuites.get_specific_version(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"0.1"
)
print(f"Original description: {ts_v1.description}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List all versions
var history = TestSuites.getVersions("e86a9a11-852f-4bac-b5a7-993b2bbbb572");
for (var version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
var v1 = TestSuites.getSpecificVersion(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
0.1
);
# List all versions
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "testSuite",
"versions": [
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.2,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"description\":\"Updated description\",\"executable\":true}",
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.1,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"executable\":true}"
]
}
Test Suite Versions
Every change to a test suite entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.List Versions
string
required
UUID of the test suite.
Get Specific Version
UseGET /v1/dataQuality/testSuites/{id}/versions/{version} to retrieve a specific version.
string
required
UUID of the test suite.
string
required
Version number to retrieve (e.g.,
0.2).GET /v1/dataQuality/testSuites/{id}/versions
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 all versions
versions = TestSuites.get_versions("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
for v in versions:
print(f"Version {v.version}: {v.description}")
# Get a specific version
ts_v1 = TestSuites.get_specific_version(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
"0.1"
)
print(f"Original description: {ts_v1.description}")
import static org.openmetadata.sdk.fluent.TestSuites.*;
// List all versions
var history = TestSuites.getVersions("e86a9a11-852f-4bac-b5a7-993b2bbbb572");
for (var version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
var v1 = TestSuites.getSpecificVersion(
"e86a9a11-852f-4bac-b5a7-993b2bbbb572",
0.1
);
# List all versions
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "testSuite",
"versions": [
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.2,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"description\":\"Updated description\",\"executable\":true}",
"{\"id\":\"e86a9a11-852f-4bac-b5a7-993b2bbbb572\",\"name\":\"b5fcae09-02c2-4c0b-8c4a-5b52d650e592\",\"version\":0.1,\"displayName\":\"Data Contract - dim_address_comprehensive_contract\",\"executable\":true}"
]
}
Returns
List versions returns an object withentityType and a versions array of serialized entity snapshots (newest first).
Get specific version returns the full test suite object as it existed at that version.
Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
404 | NOT_FOUND | Test suite or version does not exist |
Was this page helpful?
⌘I