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

Class AssetCatalogEntityResource

java.lang.Object

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

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

The AssetCatalogEntityResource provides the server-side implementation of the Asset Catalog Open Metadata Assess Service (OMAS). This interface facilitates the searching for assets, provides details about specific assets.

Constructor Summary

Constructors

Constructor and Description
AssetCatalogEntityResource()

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservice.assetcatalog.responses.ClassificationsResponse	getAssetByClassification(String userId, String assetId, Integer limit, Integer offset) Fetch the classification for a specific asset
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetDetail(String userId, String assetId) Fetch asset's header, classification and properties
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse	getAssetRelationships(String userId, String assetId, String relationshipType, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Fetch the relationships for a specific asset
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetsByClassificationName(String userId, String classificationName, String assetTypeId, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Fetch the assets that match the classification name
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetsByProperty(String userId, String propertyValue, String assetTypeId, String matchProperty, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Fetch the assets that match the properties
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetsFromNeighborhood(String userId, String assetId, List<String> assetTypeIds, List<String> relationshipTypes, org.odpi.openmetadata.accessservice.assetcatalog.model.Status relationshipStatus, Integer level) Returns the sub-graph that represents the returned linked relationships.
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetSummary(String userId, String assetId) Fetch asset's header and classification
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getAssetUniverse(String userId, String assetId) Fetch asset's header, classification, properties and relationships
List<org.odpi.openmetadata.accessservice.assetcatalog.model.AssetDescription>	getLastCreatedAssets(String userId, String assetTypeId, Date fromDate, Date toDate, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Returns the last created assets
List<org.odpi.openmetadata.accessservice.assetcatalog.model.AssetDescription>	getLastUpdatedAssets(String userId, String assetTypeId, Date fromDate, Date toDate, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Returns the last updated assets
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getLinkingAssets(String userId, String startAssetId, String endAssetId) Returns a sub-graph of intermediate assets that connected two assets
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse	getLinkingRelationships(String userId, String startAssetId, String endAssetId) Return a sub-graph of relationships that connect two assets
org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse	getRelatedAssets(String userId, String assetId, String instanceTypes, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Return the list of assets that are of the types listed in instanceTypes and are connected, either directly or indirectly to the asset identified by assetId.
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse	getRelationshipsFromNeighborhood(String userId, String assetId, List<String> assetTypeIds, List<String> relationshipTypes, org.odpi.openmetadata.accessservice.assetcatalog.model.Status relationshipStatus, Integer level) Returns the sub-graph that represents the returned linked assets
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

AssetCatalogEntityResource

public AssetCatalogEntityResource()

Method Detail

getAssetSummary

@RequestMapping(method=GET,
                path="/asset-summary/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetSummary(@PathVariable(value="userId")
                                                                                                                                                                                                                                     String userId,
                                                                                                                                                                                                                                     @PathVariable(value="assetId")
                                                                                                                                                                                                                                     String assetId)

Fetch asset's header and classification

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications

getAssetDetail

@RequestMapping(method=GET,
                path="/asset-details/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetDetail(@PathVariable(value="userId")
                                                                                                                                                                                                                                    String userId,
                                                                                                                                                                                                                                    @PathVariable(value="assetId")
                                                                                                                                                                                                                                    String assetId)

Fetch asset's header, classification and properties

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications and specific properties

getAssetUniverse

@RequestMapping(method=GET,
                path="/asset-universe/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetUniverse(@PathVariable(value="userId")
                                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                                       @PathVariable(value="assetId")
                                                                                                                                                                                                                                       String assetId)

Fetch asset's header, classification, properties and relationships

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

Returns:

the asset with its header and the list of associated classifications

getAssetRelationships

@RequestMapping(method=GET,
                path="/asset-relationships/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse getAssetRelationships(@PathVariable(value="userId")
                                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                                              @PathVariable(value="assetId")
                                                                                                                                                                                                                                              String assetId,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="type")
                                                                                                                                                                                                                                              String relationshipType,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                                              Integer limit,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                                              Integer offset,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="order.Type")
                                                                                                                                                                                                                                              org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="order.Property")
                                                                                                                                                                                                                                              String orderProperty,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                              org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Fetch the relationships for a specific asset

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

relationshipType - filter based on relationship type

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.

Returns:

list of relationships for the given asset

getAssetByClassification

@RequestMapping(method=GET,
                path="/asset-classifications/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.ClassificationsResponse getAssetByClassification(@PathVariable(value="userId")
                                                                                                                                                                                                                                                     String userId,
                                                                                                                                                                                                                                                     @PathVariable(value="assetId")
                                                                                                                                                                                                                                                     String assetId,
                                                                                                                                                                                                                                                     @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                                                     Integer limit,
                                                                                                                                                                                                                                                     @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                                                     Integer offset)

Fetch the classification for a specific asset

Parameters:

userId - the unique identifier for the user

assetId - the unique identifier for the asset

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

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

Returns:

the classification for the asset

getAssetsByProperty

@RequestMapping(method=GET,
                path="/assets-by-property/{propertyValue}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetsByProperty(@PathVariable(value="userId")
                                                                                                                                                                                                                                                    String userId,
                                                                                                                                                                                                                                                    @PathVariable(value="propertyValue")
                                                                                                                                                                                                                                                    String propertyValue,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="assetTypeId")
                                                                                                                                                                                                                                                    String assetTypeId,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="matchProperty")
                                                                                                                                                                                                                                                    String matchProperty,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                                                    Integer limit,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                                                    Integer offset,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="orderType")
                                                                                                                                                                                                                                                    org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                                                                                    String orderProperty,
                                                                                                                                                                                                                                                    @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                                    org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Fetch the assets that match the properties

Parameters:

userId - the unique identifier for the user

propertyValue - the property value searched

assetTypeId - the unique identifier for the asset type of interest

matchProperty - list of properties used to narrow the search

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.

Returns:

a list of assets that match the properties

getAssetsByClassificationName

@RequestMapping(method=GET,
                path="/assets-by-classification-name/{classificationName}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetsByClassificationName(@PathVariable(value="userId")
                                                                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                                                                              @PathVariable(value="classificationName")
                                                                                                                                                                                                                                                                              String classificationName,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="assetTypeId")
                                                                                                                                                                                                                                                                              String assetTypeId,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                                                                              Integer limit,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                                                                              Integer offset,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="orderType")
                                                                                                                                                                                                                                                                              org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                                                                                                              String orderProperty,
                                                                                                                                                                                                                                                                              @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                                                              org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Fetch the assets that match the classification name

Parameters:

userId - the unique identifier for the user

classificationName - the name of the classification

assetTypeId - filter based on asset type

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.

Returns:

a list of assets that match the classification name

getLinkingRelationships

@RequestMapping(method=GET,
                path="/assets-linking-relationships/from/{assetId}/to/{endAssetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse getLinkingRelationships(@PathVariable(value="userId")
                                                                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                                                                              @PathVariable(value="assetId")
                                                                                                                                                                                                                                                                              String startAssetId,
                                                                                                                                                                                                                                                                              @PathVariable(value="endAssetId")
                                                                                                                                                                                                                                                                              String endAssetId)

Return a sub-graph of relationships that connect two assets

Parameters:

userId - the unique identifier for the user

startAssetId - the starting asset identifier of the query

endAssetId - the ending asset identifier of the query

Returns:

a list of relationships that connects the assets

getLinkingAssets

@RequestMapping(method=GET,
                path="/linking-assets/from/{assetId}/to/{endAssetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getLinkingAssets(@PathVariable(value="userId")
                                                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                                                            @PathVariable(value="assetId")
                                                                                                                                                                                                                                                            String startAssetId,
                                                                                                                                                                                                                                                            @PathVariable(value="endAssetId")
                                                                                                                                                                                                                                                            String endAssetId)

Returns a sub-graph of intermediate assets that connected two assets

Parameters:

userId - the unique identifier for the user

startAssetId - the starting asset identifier of the query

endAssetId - the ending asset identifier of the query

Returns:

a list of assets between the given assets

getRelatedAssets

@RequestMapping(method=GET,
                path="/related-assets/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getRelatedAssets(@PathVariable(value="userId")
                                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                                       @PathVariable(value="assetId")
                                                                                                                                                                                                                                       String assetId,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="instanceTypes")
                                                                                                                                                                                                                                       String instanceTypes,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                                       Integer limit,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                                       Integer offset,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="orderType")
                                                                                                                                                                                                                                       org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                                                                       String orderProperty,
                                                                                                                                                                                                                                       @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                       org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Return the list of assets that are of the types listed in instanceTypes and are connected, either directly or indirectly to the asset identified by assetId.

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

instanceTypes - list of types to search for. Null means an type

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 - limit the result by status. By default, the relationship in all status are returned

Returns:

list of assets either directly or indirectly connected to the start asset

getAssetsFromNeighborhood

@RequestMapping(method=GET,
                path="/assets-from-neighborhood/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.AssetDescriptionResponse getAssetsFromNeighborhood(@PathVariable(value="userId")
                                                                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                                                                          @PathVariable(value="assetId")
                                                                                                                                                                                                                                                          String assetId,
                                                                                                                                                                                                                                                          @RequestParam(required=false,value="assetTypeIds")
                                                                                                                                                                                                                                                          List<String> assetTypeIds,
                                                                                                                                                                                                                                                          @RequestParam(required=false,value="relationshipTypes")
                                                                                                                                                                                                                                                          List<String> relationshipTypes,
                                                                                                                                                                                                                                                          @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                                          org.odpi.openmetadata.accessservice.assetcatalog.model.Status relationshipStatus,
                                                                                                                                                                                                                                                          @RequestParam(required=false,value="level",defaultValue="0")
                                                                                                                                                                                                                                                          Integer level)

Returns the sub-graph that represents the returned linked relationships.

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

assetTypeIds - list of asset types to include in the query results

relationshipTypes - list of relationship types to include in the query results

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

level - the number of the relationships out from the starting asset that the query will traverse to gather results

Returns:

a list of assets that in neighborhood of the given asset

getRelationshipsFromNeighborhood

@RequestMapping(method=GET,
                path="/related-relationships/{assetId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse getRelationshipsFromNeighborhood(@PathVariable(value="userId")
                                                                                                                                                                                                                                                           String userId,
                                                                                                                                                                                                                                                           @PathVariable(value="assetId")
                                                                                                                                                                                                                                                           String assetId,
                                                                                                                                                                                                                                                           @RequestParam(required=false,value="assetTypeIds")
                                                                                                                                                                                                                                                           List<String> assetTypeIds,
                                                                                                                                                                                                                                                           @RequestParam(required=false,value="relationshipTypes")
                                                                                                                                                                                                                                                           List<String> relationshipTypes,
                                                                                                                                                                                                                                                           @RequestParam(required=false,value="status")
                                                                                                                                                                                                                                                           org.odpi.openmetadata.accessservice.assetcatalog.model.Status relationshipStatus,
                                                                                                                                                                                                                                                           @RequestParam(required=false,value="level",defaultValue="0")
                                                                                                                                                                                                                                                           Integer level)

Returns the sub-graph that represents the returned linked assets

Parameters:

userId - the unique identifier for the user

assetId - the starting asset identifier of the query

assetTypeIds - list of asset types to include in the query results

relationshipTypes - list of relationship types to include in the query results

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

level - the number of the relationships out from the starting asset that the query will traverse to gather results

Returns:

a list of relationships that are linked between the assets

getLastCreatedAssets

@RequestMapping(method=GET,
                path="/last-created",
                produces="application/json")
public List<org.odpi.openmetadata.accessservice.assetcatalog.model.AssetDescription> getLastCreatedAssets(@PathVariable(value="userId")
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @RequestParam(required=false,value="assetTypeId")
                                                                                                                                                                                                                         String assetTypeId,
                                                                                                                                                                                                                         @RequestParam(required=false,value="fromDate")
                                                                                                                                                                                                                         Date fromDate,
                                                                                                                                                                                                                         @RequestParam(required=false,value="toDate")
                                                                                                                                                                                                                         Date toDate,
                                                                                                                                                                                                                         @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                         Integer limit,
                                                                                                                                                                                                                         @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                         Integer offset,
                                                                                                                                                                                                                         @RequestParam(required=false,value="orderType")
                                                                                                                                                                                                                         org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                         @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                                                         String orderProperty,
                                                                                                                                                                                                                         @RequestParam(required=false,value="status")
                                                                                                                                                                                                                         org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Returns the last created assets

Parameters:

userId - the unique identifier for the user

assetTypeId - the asset type global identifier

fromDate - the starting date for asset's creation

toDate - the ending date for asset's creation

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.

Returns:

a list of the last created assets

getLastUpdatedAssets

@RequestMapping(method=GET,
                path="/last-updated",
                produces="application/json")
public List<org.odpi.openmetadata.accessservice.assetcatalog.model.AssetDescription> getLastUpdatedAssets(@PathVariable(value="userId")
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @RequestParam(required=false,value="assetTypeId")
                                                                                                                                                                                                                         String assetTypeId,
                                                                                                                                                                                                                         @RequestParam(required=false,value="fromDate")
                                                                                                                                                                                                                         Date fromDate,
                                                                                                                                                                                                                         @RequestParam(required=false,value="toDate")
                                                                                                                                                                                                                         Date toDate,
                                                                                                                                                                                                                         @RequestParam(required=false,value="limit",defaultValue="0")
                                                                                                                                                                                                                         Integer limit,
                                                                                                                                                                                                                         @RequestParam(required=false,value="offset",defaultValue="0")
                                                                                                                                                                                                                         Integer offset,
                                                                                                                                                                                                                         @RequestParam(required=false,value="orderType")
                                                                                                                                                                                                                         org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType,
                                                                                                                                                                                                                         @RequestParam(required=false,value="orderProperty")
                                                                                                                                                                                                                         String orderProperty,
                                                                                                                                                                                                                         @RequestParam(required=false,value="status")
                                                                                                                                                                                                                         org.odpi.openmetadata.accessservice.assetcatalog.model.Status status)

Returns the last updated assets

Parameters:

userId - the unique identifier for the user

assetTypeId - the asset type global identifier

fromDate - the starting date for asset's modification

toDate - the ending date for asset's modification

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.

Returns:

a list of the last updated assets

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