Class AssetCatalogRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.assetcatalog.server.AssetCatalogRESTServices

public class AssetCatalogRESTServices extends TokenController
The AssetCatalogRESTServices provides the implementation of the Asset Catalog Open Metadata View Service (OMVS). This interface provides view interfaces for glossary UIs.
  • Constructor Details

    • AssetCatalogRESTServices

      public AssetCatalogRESTServices()
      Default constructor
  • Method Details

    • getAssetGraph

      public AssetGraphResponse getAssetGraph(String serverName, String assetGUID, QueryOptions queryOptions)
      Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.
      Parameters:
      serverName - name of the server instances for this request
      assetGUID - unique name for the connection.
      queryOptions - options to control the query
      Returns:
      graph of elements or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem retrieving the connected asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    • getAssetLineageGraph

      public AssetLineageGraphResponse getAssetLineageGraph(String serverName, String assetGUID, AssetLineageGraphRequestBody requestBody)
      Return all the elements that are linked to an asset using lineage relationships. The relationships are retrieved both from the asset, and the anchored schema elements
      Parameters:
      serverName - name of the server instances for this request
      assetGUID - unique identifier for the asset
      requestBody - list of relationship type names to use in the search
      Returns:
      graph of elements or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem retrieving the connected asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    • findInAssetDomain

      public AssetSearchMatchesListResponse findInAssetDomain(String serverName, SearchStringRequestBody requestBody)
      Return a list of assets with the requested search string in their name, qualified name or description. The search string is interpreted as a regular expression (RegEx).
      Parameters:
      serverName - name of the server instances for this request
      requestBody - string to search for in text
      Returns:
      list of results for assets that match the search string or InvalidParameterException the searchString is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties
    • getAssetsByMetadataCollectionId

      public OpenMetadataRootElementsResponse getAssetsByMetadataCollectionId(String serverName, String metadataCollectionId, FilterRequestBody requestBody)
      Return a list of assets that come from the requested metadata collection.
      Parameters:
      serverName - name of the server instances for this request
      metadataCollectionId - guid to search for
      requestBody - optional type name to restrict search by
      Returns:
      list of unique identifiers for Assets with the requested name or InvalidParameterException the name is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties
    • getSupportedTypes

      public AssetCatalogSupportedTypes getSupportedTypes(String serverName)
      Returns the list with supported types for search, including the subtypes supported. The list is deduplicated.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      the supported types from Asset Consumer OMAS or PropertyServerException if a configuration on the backend InvalidParameterException if parameter validation fails UserNotAuthorizedException security access problem