@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-catalog/users/{userId}")
public class AssetCatalogEntityResource
extends Object
| Constructor and Description |
|---|
AssetCatalogEntityResource() |
| Modifier and Type | Method and Description |
|---|---|
AssetResponse |
getAssetContext(String serverName,
String userId,
@NotBlank String assetGUID,
String assetType)
Return the full context of an asset/glossary term based on its identifier.
|
AssetDescriptionResponse |
getAssetDetail(String serverName,
String userId,
@NotBlank String assetGUID,
@NotNull String assetType)
Fetch asset's header, classification and properties
|
RelationshipsResponse |
getAssetRelationships(String serverName,
String userId,
@NotBlank String assetGUID,
String assetType,
String relationshipType,
@PositiveOrZero Integer from,
@PositiveOrZero Integer pageSize)
Fetch the relationships for a specific asset
|
AssetDescriptionResponse |
getAssetsFromNeighborhood(String serverName,
String userId,
@NotBlank String assetGUID,
SearchParameters searchParameters)
Returns the sub-graph that represents the returned linked relationships.
|
AssetDescriptionResponse |
getAssetUniverse(String serverName,
String userId,
@NotBlank String assetGUID,
@NotNull String assetType)
Fetch asset's header, classification, properties and relationships
|
ClassificationsResponse |
getClassificationsForAsset(String serverName,
String userId,
@NotBlank String assetGUID,
String assetType,
String classificationName)
Fetch the classification for a specific asset
|
AssetDescriptionResponse |
getLinkingAssets(String serverName,
String userId,
@NotBlank String startAssetGUID,
@NotBlank String endAssetGUID)
Returns a sub-graph of intermediate assets that connected two assets
|
RelationshipsResponse |
getLinkingRelationships(String serverName,
String userId,
String startAssetGUID,
String endAssetGUID)
Return a sub-graph of relationships that connect two assets
|
AssetCatalogSupportedTypes |
getSupportedTypes(String serverName,
String userId,
String type)
Returns the list with supported types for search, including the sub-types supported
|
AssetResponse |
searchByType(String serverName,
String userId,
@NotBlank String searchCriteria,
SearchParameters searchParameters)
Return a list of assets matching the search criteria without the full context
|
@GetMapping(path="/asset-details/{assetGUID}",
produces="application/json")
public AssetDescriptionResponse getAssetDetail(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestParam(name="assetType",required=false) @NotNull
@NotNull String assetType)
serverName - unique identifier for requested server.userId - the unique identifier for the userassetGUID - the unique identifier for the assetassetType - the type of the asset@GetMapping(path="/asset-universe/{assetGUID}",
produces="application/json")
public AssetDescriptionResponse getAssetUniverse(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestParam(name="assetType",required=false) @NotNull
@NotNull String assetType)
serverName - unique identifier for requested server.userId - the unique identifier for the userassetGUID - the unique identifier for the assetassetType - the asset type@GetMapping(path="/asset-relationships/{assetGUID}",
produces="application/json")
public RelationshipsResponse getAssetRelationships(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestParam(name="assetType",required=false)
String assetType,
@RequestParam(name="relationshipType",required=false)
String relationshipType,
@RequestParam(name="from",required=false,defaultValue="0") @PositiveOrZero
@PositiveOrZero Integer from,
@RequestParam(name="pageSize",required=false,defaultValue="100") @PositiveOrZero
@PositiveOrZero Integer pageSize)
serverName - unique identifier for requested serveruserId - the unique identifier for the userassetGUID - the unique identifier for the assetassetType - the type of the assetrelationshipType - the type of the relationshipfrom - offsetpageSize - limit the number of the assets returned@GetMapping(path="/asset-classifications/{assetGUID}",
produces="application/json")
public ClassificationsResponse getClassificationsForAsset(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestParam(name="assetType",required=false)
String assetType,
@RequestParam(name="classificationName",required=false)
String classificationName)
serverName - unique identifier for requested server.userId - the unique identifier for the userassetGUID - the unique identifier for the assetassetType - the type of the assetclassificationName - the name of the classification@GetMapping(path="/linking-assets/from/{assetGUID}/to/{endAssetGUID}",
produces="application/json")
public AssetDescriptionResponse getLinkingAssets(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String startAssetGUID,
@PathVariable(value="endAssetGUID") @NotBlank
@NotBlank String endAssetGUID)
serverName - unique identifier for requested server.userId - the unique identifier for the userstartAssetGUID - the starting asset identifier of the queryendAssetGUID - the ending asset identifier of the query@GetMapping(path="/linking-assets-relationships/from/{assetGUID}/to/{endAssetGUID}",
produces="application/json")
public RelationshipsResponse getLinkingRelationships(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID")
String startAssetGUID,
@PathVariable(value="endAssetGUID")
String endAssetGUID)
serverName - unique identifier for requested server.userId - the unique identifier for the userstartAssetGUID - the starting asset identifier of the queryendAssetGUID - the ending asset identifier of the query@PostMapping(path="/assets-from-neighborhood/{assetGUID}",
produces="application/json")
public AssetDescriptionResponse getAssetsFromNeighborhood(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestBody
SearchParameters searchParameters)
serverName - unique identifier for requested server.userId - the unique identifier for the userassetGUID - the starting asset identifier of the querysearchParameters - constrains to make the assets's search results more precise@PostMapping(path="/search",
produces="application/json")
public AssetResponse searchByType(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@RequestParam(value="searchCriteria") @NotBlank
@NotBlank String searchCriteria,
@RequestBody
SearchParameters searchParameters)
serverName - unique identifier for requested server.userId - the unique identifier for the usersearchCriteria - a string expression of the characteristics of the required assetssearchParameters - constrains to make the assets's search results more precise@GetMapping(path="/asset-context/{assetGUID}",
produces="application/json")
public AssetResponse getAssetContext(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@PathVariable(value="assetGUID") @NotBlank
@NotBlank String assetGUID,
@RequestParam(name="assetType",required=false)
String assetType)
serverName - unique identifier for requested server.userId - the unique identifier for the userassetGUID - the global unique identifier of the assetassetType - the type of the asset@GetMapping(path="/supportedTypes",
produces="application/json")
public AssetCatalogSupportedTypes getSupportedTypes(@PathVariable(value="serverName")
String serverName,
@PathVariable(value="userId")
String userId,
@RequestParam(name="type",required=false) @Nullable
String type)
serverName - unique identifier for requested serveruserId - the unique identifier for the usertype - the typeCopyright © 2018–2020 ODPi. All rights reserved.