GET /v1/services/databaseServices/{id}/versions
import json
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List all versions
versions = DatabaseServices.get_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
for v in versions:
version = json.loads(v)
print(f"Version {version['version']}: {version.get('description')}")
# Get a specific version
service_v1 = DatabaseServices.get_specific_version(
"a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"0.1"
)
print(f"Original description: {getattr(service_v1.description, 'root', service_v1.description)}")
import org.openmetadata.schema.entity.services.DatabaseService;
import org.openmetadata.schema.type.EntityHistory;
// client is an initialized OpenMetadataClient.
// List all versions
EntityHistory history = client.databaseServices().getVersionList("a1b2c3d4-e5f6-7890-abcd-ef1234567890");
for (Object version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
DatabaseService v1 = client.databaseServices().getVersion("a1b2c3d4-e5f6-7890-abcd-ef1234567890", 0.1);
System.out.println("Description: " + v1.getDescription());
# List all versions
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "databaseService",
"versions": [
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Updated BigQuery data service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Sample data service for BigQuery\",\"version\":0.1,\"updatedAt\":1769982650000,\"updatedBy\":\"admin\",\"deleted\":false}"
]
}
Database Service Versions
List and retrieve historical versions of a database service
GET
/
v1
/
services
/
databaseServices
/
{id}
/
versions
GET /v1/services/databaseServices/{id}/versions
import json
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List all versions
versions = DatabaseServices.get_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
for v in versions:
version = json.loads(v)
print(f"Version {version['version']}: {version.get('description')}")
# Get a specific version
service_v1 = DatabaseServices.get_specific_version(
"a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"0.1"
)
print(f"Original description: {getattr(service_v1.description, 'root', service_v1.description)}")
import org.openmetadata.schema.entity.services.DatabaseService;
import org.openmetadata.schema.type.EntityHistory;
// client is an initialized OpenMetadataClient.
// List all versions
EntityHistory history = client.databaseServices().getVersionList("a1b2c3d4-e5f6-7890-abcd-ef1234567890");
for (Object version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
DatabaseService v1 = client.databaseServices().getVersion("a1b2c3d4-e5f6-7890-abcd-ef1234567890", 0.1);
System.out.println("Description: " + v1.getDescription());
# List all versions
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "databaseService",
"versions": [
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Updated BigQuery data service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Sample data service for BigQuery\",\"version\":0.1,\"updatedAt\":1769982650000,\"updatedBy\":\"admin\",\"deleted\":false}"
]
}
Database Service Versions
Every change to a database service entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.List Versions
string
required
UUID of the database service.
Get Specific Version
UseGET /v1/services/databaseServices/{id}/versions/{version} to retrieve a specific version.
string
required
UUID of the database service.
string
required
Version number to retrieve, for example
0.2.GET /v1/services/databaseServices/{id}/versions
import json
from metadata.sdk import configure
from metadata.sdk.entities import DatabaseServices
configure(
host="https://your-company.open-metadata.org/api",
jwt_token="your-jwt-token"
)
# List all versions
versions = DatabaseServices.get_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
for v in versions:
version = json.loads(v)
print(f"Version {version['version']}: {version.get('description')}")
# Get a specific version
service_v1 = DatabaseServices.get_specific_version(
"a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"0.1"
)
print(f"Original description: {getattr(service_v1.description, 'root', service_v1.description)}")
import org.openmetadata.schema.entity.services.DatabaseService;
import org.openmetadata.schema.type.EntityHistory;
// client is an initialized OpenMetadataClient.
// List all versions
EntityHistory history = client.databaseServices().getVersionList("a1b2c3d4-e5f6-7890-abcd-ef1234567890");
for (Object version : history.getVersions()) {
System.out.println("Version: " + version);
}
// Get a specific version
DatabaseService v1 = client.databaseServices().getVersion("a1b2c3d4-e5f6-7890-abcd-ef1234567890", 0.1);
System.out.println("Description: " + v1.getDescription());
# List all versions
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions" \
-H "Authorization: Bearer {access_token}"
# Get a specific version
curl "{base_url}/api/v1/services/databaseServices/fd2193af-fe09-4366-92b7-1e0d01cd8c09/versions/0.1" \
-H "Authorization: Bearer {access_token}"
{
"entityType": "databaseService",
"versions": [
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Updated BigQuery data service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
"{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Sample data service for BigQuery\",\"version\":0.1,\"updatedAt\":1769982650000,\"updatedBy\":\"admin\",\"deleted\":false}"
]
}
Returns
List versions returns an object withentityType and a versions array of serialized entity snapshots (newest first).
Get specific version returns the full database service object as it existed at that version.
Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
404 | NOT_FOUND | Database service or version does not exist |
Was this page helpful?