Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
dataQuality
/
testCases
/
{id}
/
versions
GET /v1/dataQuality/testCases/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import TestCases

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

# List all versions
versions = TestCases.get_versions("c1bce355-fa2f-48c6-ab4d-fad722a56ed7")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
tc_v1 = TestCases.get_specific_version(
    "c1bce355-fa2f-48c6-ab4d-fad722a56ed7",
    "0.1"
)
print(f"Original params: {tc_v1.parameterValues}")

{
  "entityType": "testCase",
  "versions": [
    "{\"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\",\"version\":0.2,\"description\":\"Updated description\",\"parameterValues\":[{\"name\":\"minValueForMaxInCol\",\"value\":\"1\"},{\"name\":\"maxValueForMaxInCol\",\"value\":\"200\"}]}",
    "{\"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\",\"version\":0.1,\"parameterValues\":[{\"name\":\"minValueForMaxInCol\",\"value\":\"1\"},{\"name\":\"maxValueForMaxInCol\",\"value\":\"100\"}]}"
  ]
}

​
Test Case Versions

Every change to a test case entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.

​
List Versions

​
id
string
required
UUID of the test case.

​
Get Specific Version

Use GET /v1/dataQuality/testCases/{id}/versions/{version} to retrieve a specific version.
​
id
string
required
UUID of the test case.
​
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/dataQuality/testCases/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import TestCases

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

# List all versions
versions = TestCases.get_versions("c1bce355-fa2f-48c6-ab4d-fad722a56ed7")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
tc_v1 = TestCases.get_specific_version(
    "c1bce355-fa2f-48c6-ab4d-fad722a56ed7",
    "0.1"
)
print(f"Original params: {tc_v1.parameterValues}")

{
  "entityType": "testCase",
  "versions": [
    "{\"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\",\"version\":0.2,\"description\":\"Updated description\",\"parameterValues\":[{\"name\":\"minValueForMaxInCol\",\"value\":\"1\"},{\"name\":\"maxValueForMaxInCol\",\"value\":\"200\"}]}",
    "{\"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\",\"version\":0.1,\"parameterValues\":[{\"name\":\"minValueForMaxInCol\",\"value\":\"1\"},{\"name\":\"maxValueForMaxInCol\",\"value\":\"100\"}]}"
  ]
}

​
Returns

List versions returns an object with entityType and a versions array of serialized entity snapshots (newest first). Get specific version returns the full test case object as it existed at that version.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
404NOT_FOUNDTest case or version does not exist