Package org.odpi.openmetadata.userinterface.uichassis.springboot.api.asset

Class AssetController

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.api.asset.AssetController

@RestController
@RequestMapping("/api/assets")
public class AssetController
extends Object

Constructor Summary

Constructors

Constructor	Description
AssetController()

Method Summary

Modifier and Type	Method	Description
AssetCatalogBean	getAsset(String guid)
Elements	getAssetContext(String guid)
List<Type>	getSupportedTypes()
List<Elements>	searchAssets(String searchCriteria, List<String> types, String sequencingProperty, SequencingOrder sequencingOrder, boolean caseSensitive, boolean exactMatch, Integer from, Integer pageSize)
List<Elements>	searchAssetsByTypeGUID(String typeGUID)
List<Elements>	searchAssetsByTypeName(String typeName)

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetController

public AssetController()

Method Detail

searchAssets

@GetMapping(path="/search")
public List<Elements> searchAssets(@RequestParam("q")
                                   String searchCriteria,
                                   @RequestParam("types")
                                   List<String> types,
                                   @RequestParam(name="sequencingProperty",defaultValue="displayName")
                                   String sequencingProperty,
                                   @RequestParam(name="sequencingOrder",defaultValue="PROPERTY_ASCENDING")
                                   SequencingOrder sequencingOrder,
                                   @RequestParam(defaultValue="false")
                                   boolean caseSensitive,
                                   @RequestParam(defaultValue="false")
                                   boolean exactMatch,
                                   @RequestParam(defaultValue="0")
                                   Integer from,
                                   @RequestParam(defaultValue="10")
                                   Integer pageSize)
                            throws PropertyServerException,
                                   InvalidParameterException

Parameters:

searchCriteria - the query parameter with the search phrase

types - OM types list to search for

sequencingProperty - name of the property based on which to sort the result

sequencingOrder - PROPERTY_ASCENDING or PROPERTY_DESCENDING

caseSensitive - set case sensitive flag

exactMatch - set exact match flag

from - the offset for the results

pageSize - the number of results per page

Returns:

list of assets

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

searchAssetsByTypeName

@GetMapping(path="/search-by-type-name/{typeName}")
public List<Elements> searchAssetsByTypeName(@PathVariable("typeName")
                                             String typeName)
                                      throws PropertyServerException,
                                             InvalidParameterException

Parameters:

typeName - the assets type name to search for

Returns:

list of assets by type name

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

searchAssetsByTypeGUID

@GetMapping(path="/search-by-type-guid/{typeGUID}")
public List<Elements> searchAssetsByTypeGUID(@PathVariable("typeGUID")
                                             String typeGUID)
                                      throws PropertyServerException,
                                             InvalidParameterException

Parameters:

typeGUID - the assets type GUID to search for

Returns:

list of assets by type GUID

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

getSupportedTypes

@GetMapping(path="/types")
public List<Type> getSupportedTypes()
                             throws PropertyServerException,
                                    InvalidParameterException

Returns:

the supported types from AssetCatalog OMAS

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

getAsset

@GetMapping("/{guid}")
public AssetCatalogBean getAsset(@PathVariable("guid")
                                 String guid)
                          throws PropertyServerException,
                                 InvalidParameterException

Parameters:

guid - of the Entity to be retrieved

Returns:

the entity details

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails

getAssetContext

@GetMapping("/{guid}/context")
public Elements getAssetContext(@PathVariable("guid")
                                String guid)
                         throws PropertyServerException,
                                InvalidParameterException

Parameters:

guid - of the Entity to be retrieved

Returns:

the entity context

Throws:

PropertyServerException - if a configuration on the backend

InvalidParameterException - if parameter validation fails