GET /v1/services/mlmodelServices/{id}
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
AuthProvider,
OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.mlmodelService import MlModelService
metadata = OpenMetadata(
OpenMetadataConnection(
hostPort="https://your-company.open-metadata.org/api",
authProvider=AuthProvider.openmetadata,
securityConfig=OpenMetadataJWTClientConfig(jwtToken="your-jwt-token"),
)
)
# Get by ID
svc = metadata.get_by_id(entity=MlModelService, entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName.root}: {svc.serviceType.value}")
# Get by ID with fields
svc = metadata.get_by_id(
entity=MlModelService,
entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9",
fields=["owners", "tags"]
)
# Get by fully qualified name
svc = metadata.get_by_name(entity=MlModelService, fqn="mlflow_svc")
# Get by name with fields
svc = metadata.get_by_name(
entity=MlModelService,
fqn="mlflow_svc",
fields=["owners", "tags", "domains"]
)
import org.openmetadata.schema.entity.services.MlModelService;
import org.openmetadata.sdk.fluent.MlModelServices;
// Get by ID
MlModelService service = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");
// Get by ID with fields
MlModelService serviceWithFields = MlModelServices.retrieve(
"ca22d46e-81b9-4e48-85b5-0adc44980da9",
"owners,tags"
);
// Get by fully qualified name
MlModelService serviceByName = MlModelServices.retrieveByName("mlflow_svc");
// Get by name with fields
MlModelService serviceByNameWithFields = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");
# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
-H "Authorization: Bearer {access_token}"
# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
-H "Authorization: Bearer {access_token}"
# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
{
"id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
"name": "mlflow_svc",
"fullyQualifiedName": "mlflow_svc",
"serviceType": "Mlflow",
"version": 0.1,
"updatedAt": 1769982621618,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
"connection": {
"config": {
"type": "Mlflow",
"trackingUri": "http://localhost:8088",
"registryUri": "http://localhost:8088",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Retrieve an ML Model Service
Get an ML model service by ID or fully qualified name
GET
/
v1
/
services
/
mlmodelServices
/
{id}
GET /v1/services/mlmodelServices/{id}
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
AuthProvider,
OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.mlmodelService import MlModelService
metadata = OpenMetadata(
OpenMetadataConnection(
hostPort="https://your-company.open-metadata.org/api",
authProvider=AuthProvider.openmetadata,
securityConfig=OpenMetadataJWTClientConfig(jwtToken="your-jwt-token"),
)
)
# Get by ID
svc = metadata.get_by_id(entity=MlModelService, entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName.root}: {svc.serviceType.value}")
# Get by ID with fields
svc = metadata.get_by_id(
entity=MlModelService,
entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9",
fields=["owners", "tags"]
)
# Get by fully qualified name
svc = metadata.get_by_name(entity=MlModelService, fqn="mlflow_svc")
# Get by name with fields
svc = metadata.get_by_name(
entity=MlModelService,
fqn="mlflow_svc",
fields=["owners", "tags", "domains"]
)
import org.openmetadata.schema.entity.services.MlModelService;
import org.openmetadata.sdk.fluent.MlModelServices;
// Get by ID
MlModelService service = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");
// Get by ID with fields
MlModelService serviceWithFields = MlModelServices.retrieve(
"ca22d46e-81b9-4e48-85b5-0adc44980da9",
"owners,tags"
);
// Get by fully qualified name
MlModelService serviceByName = MlModelServices.retrieveByName("mlflow_svc");
// Get by name with fields
MlModelService serviceByNameWithFields = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");
# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
-H "Authorization: Bearer {access_token}"
# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
-H "Authorization: Bearer {access_token}"
# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
{
"id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
"name": "mlflow_svc",
"fullyQualifiedName": "mlflow_svc",
"serviceType": "Mlflow",
"version": 0.1,
"updatedAt": 1769982621618,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
"connection": {
"config": {
"type": "Mlflow",
"trackingUri": "http://localhost:8088",
"registryUri": "http://localhost:8088",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Retrieve an ML Model Service
Get a single ML model service by its unique ID or fully qualified name.Get by ID
string
required
UUID of the ML model service to retrieve.
string
Comma-separated list of fields to include, for example
owners,tags,domains.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.Get by Fully Qualified Name
UseGET /v1/services/mlmodelServices/name/{fqn} to retrieve by fully qualified name.
string
required
Fully qualified name of the ML model service, for example
mlflow_svc.string
Comma-separated list of fields to include:
owners, tags, domains.string
default:"non-deleted"
Include
all, deleted, or non-deleted entities.GET /v1/services/mlmodelServices/{id}
from metadata.generated.schema.entity.services.connections.metadata.openMetadataConnection import (
AuthProvider,
OpenMetadataConnection,
)
from metadata.generated.schema.security.client.openMetadataJWTClientConfig import (
OpenMetadataJWTClientConfig,
)
from metadata.ingestion.ometa.ometa_api import OpenMetadata
from metadata.generated.schema.entity.services.mlmodelService import MlModelService
metadata = OpenMetadata(
OpenMetadataConnection(
hostPort="https://your-company.open-metadata.org/api",
authProvider=AuthProvider.openmetadata,
securityConfig=OpenMetadataJWTClientConfig(jwtToken="your-jwt-token"),
)
)
# Get by ID
svc = metadata.get_by_id(entity=MlModelService, entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9")
print(f"{svc.fullyQualifiedName.root}: {svc.serviceType.value}")
# Get by ID with fields
svc = metadata.get_by_id(
entity=MlModelService,
entity_id="ca22d46e-81b9-4e48-85b5-0adc44980da9",
fields=["owners", "tags"]
)
# Get by fully qualified name
svc = metadata.get_by_name(entity=MlModelService, fqn="mlflow_svc")
# Get by name with fields
svc = metadata.get_by_name(
entity=MlModelService,
fqn="mlflow_svc",
fields=["owners", "tags", "domains"]
)
import org.openmetadata.schema.entity.services.MlModelService;
import org.openmetadata.sdk.fluent.MlModelServices;
// Get by ID
MlModelService service = MlModelServices.retrieve("ca22d46e-81b9-4e48-85b5-0adc44980da9");
// Get by ID with fields
MlModelService serviceWithFields = MlModelServices.retrieve(
"ca22d46e-81b9-4e48-85b5-0adc44980da9",
"owners,tags"
);
// Get by fully qualified name
MlModelService serviceByName = MlModelServices.retrieveByName("mlflow_svc");
// Get by name with fields
MlModelService serviceByNameWithFields = MlModelServices.retrieveByName("mlflow_svc", "owners,tags,domains");
# Get by ID
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9" \
-H "Authorization: Bearer {access_token}"
# Get by ID with fields
curl "{base_url}/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
# Get by fully qualified name
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc" \
-H "Authorization: Bearer {access_token}"
# Get by name with fields
curl "{base_url}/api/v1/services/mlmodelServices/name/mlflow_svc?fields=owners,tags,domains" \
-H "Authorization: Bearer {access_token}"
{
"id": "ca22d46e-81b9-4e48-85b5-0adc44980da9",
"name": "mlflow_svc",
"fullyQualifiedName": "mlflow_svc",
"serviceType": "Mlflow",
"version": 0.1,
"updatedAt": 1769982621618,
"updatedBy": "admin",
"href": "http://localhost:8585/api/v1/services/mlmodelServices/ca22d46e-81b9-4e48-85b5-0adc44980da9",
"connection": {
"config": {
"type": "Mlflow",
"trackingUri": "http://localhost:8088",
"registryUri": "http://localhost:8088",
"supportsMetadataExtraction": true
}
},
"owners": [],
"tags": [],
"deleted": false,
"domains": []
}
Returns
Returns an ML model service object with all requested fields populated.Response
string
Unique identifier for the ML model service (UUID format).
string
ML model service name.
string
Fully qualified name of the service.
string
Human-readable display name.
string
Description of the ML model service in Markdown format.
string
Type of ML model service, for example Mlflow, Sklearn, SageMaker, CustomMlModel.
object
Connection configuration for the service.
Show properties
Show properties
object
Service-specific connection configuration.
number
Version number for the entity.
array
List of owners. Only included when
fields contains owners.array
Classification tags. Only included when
fields contains tags.array
Domain assignments. Only included when
fields contains domains.Error Handling
| Code | Error Type | Description |
|---|---|---|
401 | UNAUTHORIZED | Invalid or missing authentication token |
403 | FORBIDDEN | User lacks permission to view this ML model service |
404 | NOT_FOUND | ML model service with given ID or FQN does not exist |
Was this page helpful?