Package org.odpi.openmetadata.viewservices.assetcatalog.server.spring

Class AssetCatalogResource

java.lang.Object

org.odpi.openmetadata.viewservices.assetcatalog.server.spring.AssetCatalogResource

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/asset-catalog")
public class AssetCatalogResource
extends Object

The AssetCatalogResource provides some of the REST API endpoints of the Asset Catalog Open Metadata View Service (OMVS).

Constructor Summary

Constructors

Constructor	Description
AssetCatalogResource()	Default constructor

Method Summary

Modifier and Type	Method	Description
AssetSearchMatchesListResponse	findInAssetDomain(String serverName, SearchStringRequestBody requestBody)	Locate string value in elements that are anchored to assets.
AssetGraphResponse	getAssetGraph(String serverName, String assetGUID, ResultsRequestBody requestBody)	Return all the elements that are anchored to an asset plus relationships between these elements and to other elements.
AssetLineageGraphResponse	getAssetLineageGraph(String serverName, String assetGUID, AssetLineageGraphRequestBody requestBody)	Return all the elements that are linked to an asset using lineage relationships.
OpenMetadataRootElementsResponse	getAssetsByMetadataCollectionId(String serverName, String metadataCollectionId, FilterRequestBody requestBody)	Return a list of assets that come from the requested metadata collection.
AssetCatalogSupportedTypes	getAssetTypes(String serverName)	Return the subtypes for asset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AssetCatalogResource

public AssetCatalogResource()

Default constructor

Method Details

getAssetTypes

@GetMapping(path="/assets/types")
public AssetCatalogSupportedTypes getAssetTypes(@PathVariable
 String serverName)

Return the subtypes for asset.

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

getAssetGraph

@PostMapping(path="/assets/{assetGUID}/as-graph")
public AssetGraphResponse getAssetGraph(@PathVariable
 String serverName,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 ResultsRequestBody requestBody)

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 - uniqueId for the connection.

requestBody - options used to retrieve metadata

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 UnrecognizedConnectionGUIDException the supplied GUID is not recognized by the property server or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getAssetLineageGraph

@PostMapping(path="/assets/{assetGUID}/as-lineage-graph")
public AssetLineageGraphResponse getAssetLineageGraph(@PathVariable
 String serverName,
 @PathVariable
 String assetGUID,
 @RequestBody(required=false)
 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 plus information supply chain details

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

@PostMapping(path="/assets/in-domain/by-search-string")
public AssetSearchMatchesListResponse findInAssetDomain(@PathVariable
 String serverName,
 @RequestBody(required=false)
 SearchStringRequestBody requestBody)

Locate string value in elements that are anchored to assets. The search string may be a 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

@PostMapping(path="/assets/by-metadata-collection-id/{metadataCollectionId}")
public OpenMetadataRootElementsResponse getAssetsByMetadataCollectionId(@PathVariable
 String serverName,
 @PathVariable
 String metadataCollectionId,
 @RequestBody(required=false)
 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