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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssetCatalogBeangetAsset(String guid)ElementsgetAssetContext(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)
-
-
-
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 phrasetypes- OM types list to search forsequencingProperty- name of the property based on which to sort the resultsequencingOrder- PROPERTY_ASCENDING or PROPERTY_DESCENDINGcaseSensitive- set case sensitive flagexactMatch- set exact match flagfrom- the offset for the resultspageSize- the number of results per page- Returns:
- list of assets
- Throws:
PropertyServerException- if a configuration on the backendInvalidParameterException- 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 backendInvalidParameterException- 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 backendInvalidParameterException- 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 backendInvalidParameterException- if parameter validation fails
-
-