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

Class AssetController

java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
AssetController()

Method Summary

Modifier and Type	Method and Description
AssetDescription	getAsset(String guid)
AssetElements	getAssetContext(String guid)
List<Type>	getSupportedTypes()
List<AssetElements>	searchAssets(String searchCriteria, List<String> types)

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<AssetElements> searchAssets(@RequestParam(value="q")
                                                                    String searchCriteria,
                                                                    @RequestParam(value="types")
                                                                    List<String> types)
                                                             throws PropertyServerException,
                                                                    InvalidParameterException

Parameters:

searchCriteria - the query parameter with the search phrase

Returns:

list of assets

Throws:

PropertyServerException

InvalidParameterException

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(value="/{guid}")
public AssetDescription getAsset(@PathVariable(value="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(value="/{guid}/context")
public AssetElements getAssetContext(@PathVariable(value="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