org.odpi.openmetadata.accessservice.assetcatalog.server.spring

Class AssetCatalogResource

java.lang.Object

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

@RestController
 @RequestMapping(value="/open-metadata/access-services/asset-catalog/users/{userId}")
public class AssetCatalogResource
extends Object

The AssetCatalogRelationshipResource provides the server-side implementation of the Asset Catalog Open Metadata Assess Service (OMAS). This interface facilitates the searching for asset's details, provides the connection to a specific asset.

Constructor Summary

Constructors

Constructor and Description
AssetCatalogResource()

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	searchAssets(String userId, String searchCriteria, Integer limit, Integer offset, SequencingOrder orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status, Boolean excludeDeleted) Return a list of assets (details and connections) matching the search criteria

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetCatalogResource

public AssetCatalogResource()

Method Detail

searchAssets

@RequestMapping(method=GET,
                path="/search-asset/{searchCriteria}")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse searchAssets(@PathVariable(value="userId")
                                                                                                                                                                                           String userId,
                                                                                                                                                                                           @PathVariable(value="searchCriteria")
                                                                                                                                                                                           String searchCriteria,
                                                                                                                                                                                           @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                           Integer limit,
                                                                                                                                                                                           @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                           Integer offset,
                                                                                                                                                                                           @RequestParam(required=false,value="orderType")
                                                                                                                                                                                           SequencingOrder orderType,
                                                                                                                                                                                           @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                           String orderProperty,
                                                                                                                                                                                           @RequestParam(required=false,value="status")
                                                                                                                                                                                           org.odpi.openmetadata.accessservice.assetcatalog.model.Status status,
                                                                                                                                                                                           @RequestParam(required=false,value="excludeDeleted")
                                                                                                                                                                                           Boolean excludeDeleted)

Return a list of assets (details and connections) matching the search criteria

Parameters:

userId - the unique identifier for the user

searchCriteria - a string expression of the characteristics of the required assets

limit - limit the result set to only include the specified number of entries

offset - start offset of the result set (for pagination)

orderType - enum defining how the results should be ordered.

orderProperty - the name of the property that is to be used to sequence the results

status - By default, relationships in all statuses are returned. However, it is possible to specify a single status (eg ACTIVE) to restrict the results to.

excludeDeleted - exclude deleted entities from result

Returns:

list of properties used to narrow the search