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

Class AssetCatalogRelationshipResource

java.lang.Object

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

@RestController
 @RequestMapping(value="/open-metadata/access-services/asset-catalog/users/{userId}/relationships")
public class AssetCatalogRelationshipResource
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 relationships, fetch the details about a specific relationship.

Constructor Summary

Constructors

Constructor and Description
AssetCatalogRelationshipResource()

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipResponse	getRelationship(String userId, String relationshipId) Fetch relationship details based on its unique identifier
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse	getRelationshipByLabel(String userId, String propertyName, String propertyValue, String relationshipTypeId, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Fetch relationship details based on property name
org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse	searchForRelationships(String userId, String relationshipTypeId, String criteria, Integer limit, Integer offset, org.odpi.openmetadata.accessservice.assetcatalog.model.SequenceOrderType orderType, String orderProperty, org.odpi.openmetadata.accessservice.assetcatalog.model.Status status) Return a list of relationships that match the search criteria.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetCatalogRelationshipResource

public AssetCatalogRelationshipResource()

Method Detail

getRelationship

@RequestMapping(method=GET,
                path="/{relationshipId}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipResponse getRelationship(@PathVariable(value="userId")
                                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                                          @PathVariable(value="relationshipId")
                                                                                                                                                                                                                          String relationshipId)

Fetch relationship details based on its unique identifier

Parameters:

userId - String unique identifier for the user

relationshipId - String unique identifier for the relationship

Returns:

relationship details

getRelationshipByLabel

@RequestMapping(method=GET,
                path="/property-name/{propertyName}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse getRelationshipByLabel(@PathVariable(value="userId")
                                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                                              @PathVariable(value="propertyName")
                                                                                                                                                                                                                                              String propertyName,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="propertyValue")
                                                                                                                                                                                                                                              String propertyValue,
                                                                                                                                                                                                                                              @RequestParam(required=false,value="relationshipTypeId")
                                                                                                                                                                                                                                              String relationshipTypeId,
                                                                                                                                                                                                                                              @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 relationship details based on property name

Parameters:

userId - String unique identifier for the user

propertyName - String that it is used to identify the relationship label

propertyValue - list of properties used to narrow the search.

relationshipTypeId - limit the result to include the specific 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:

a list of relationships that have the property specified

searchForRelationships

@RequestMapping(method=GET,
                path="/type/{relationshipTypeId}/search/{criteria}",
                produces="application/json")
public org.odpi.openmetadata.accessservice.assetcatalog.responses.RelationshipsResponse searchForRelationships(@PathVariable(value="userId")
                                                                                                                                                                                                                                                             String userId,
                                                                                                                                                                                                                                                             @PathVariable(value="relationshipTypeId")
                                                                                                                                                                                                                                                             String relationshipTypeId,
                                                                                                                                                                                                                                                             @PathVariable(value="criteria")
                                                                                                                                                                                                                                                             String criteria,
                                                                                                                                                                                                                                                             @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 a list of relationships that match the search criteria.

Parameters:

userId - String unique identifier for the user

relationshipTypeId - limit the result set to only include the specified types for relationships

criteria - String for searching the relationship

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 relationships that match the search criteria