org.odpi.openmetadata.accessservices.connectedasset.server.spring

Class ConnectedAssetOMASResource

java.lang.Object

org.odpi.openmetadata.accessservices.connectedasset.server.spring.ConnectedAssetOMASResource

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

The ConnectedAssetRESTServices is the server-side implementation of the Connected Asset OMAS REST interface.

Constructor Summary

Constructors

Constructor and Description
ConnectedAssetOMASResource() Default constructor

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countAnnotations(String userId, String assetGUID) Returns the count of annotations for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countCertifications(String userId, String assetGUID) Returns the count of certifications for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countComments(String userId, String assetGUID) Returns the count of comments for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countConnections(String userId, String assetGUID) Returns the count of connections for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countExternalIdentifiers(String userId, String assetGUID) Returns the count of external identifiers for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countExternalReferences(String userId, String assetGUID) Returns the count of external references for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countInformalTags(String userId, String assetGUID) Returns the count of informal tags for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countKnownLocations(String userId, String assetGUID) Returns the count of known locations for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countLikes(String userId, String assetGUID) Returns the count of likes for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countMeanings(String userId, String assetGUID) Returns the count of meanings for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countNoteLogs(String userId, String assetGUID) Returns the count of note logs for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countNotes(String userId, String assetGUID) Returns the count of notes for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countRatings(String userId, String assetGUID) Returns the count of ratings for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countRelatedAssets(String userId, String assetGUID) Returns the count of related assets for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	countRelatedMediaReferences(String userId, String assetGUID) Returns the count of related media references for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.AnnotationsResponse	getAnnotations(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of annotations for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.AssetResponse	getAssetSummary(String userId, String assetGUID) Returns the basic information about the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CertificationsResponse	getCertifications(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of certifications for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CommentsResponse	getComments(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of comments for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.ConnectionsResponse	getConnections(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of connections for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.ExternalIdentifiersResponse	getExternalIdentifiers(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of external identifiers for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.ExternalReferencesResponse	getExternalReferences(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of external references for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.InformalTagsResponse	getInformalTags(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of informal tags for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.LocationsResponse	getKnownLocations(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of known locations for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse	getLicenses(String userId, String assetGUID) Returns the count of licenses for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.LicensesResponse	getLicenses(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of licenses for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.LikesResponse	getLikes(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of likes for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.MeaningsResponse	getMeanings(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of meanings for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.NoteLogsResponse	getNoteLogs(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of note logs for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.NotesResponse	getNotes(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of notes for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.RatingsResponse	getRatings(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of ratings for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.RelatedAssetsResponse	getRelatedAssets(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of related assets for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.RelatedMediaReferencesResponse	getRelatedMediaReferences(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of related media references for the asset.
org.odpi.openmetadata.accessservices.connectedasset.rest.SchemaResponse	getSchema(String userId, String assetGUID, int elementStart, int maxElements) Returns the schema for the asset.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedAssetOMASResource

public ConnectedAssetOMASResource()

Default constructor

Method Detail

getAssetSummary

@RequestMapping(method=GET,
                path="/assets/{assetGUID}")
public org.odpi.openmetadata.accessservices.connectedasset.rest.AssetResponse getAssetSummary(@PathVariable
                                                                                                                                                                      String userId,
                                                                                                                                                                      @PathVariable
                                                                                                                                                                      String assetGUID)

Returns the basic information about the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a bean with the basic properties about the asset or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAnnotations

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/annotations")
public org.odpi.openmetadata.accessservices.connectedasset.rest.AnnotationsResponse getAnnotations(@PathVariable
                                                                                                                                                                                       String userId,
                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                       String assetGUID,
                                                                                                                                                                                       @RequestParam
                                                                                                                                                                                       int elementStart,
                                                                                                                                                                                       @RequestParam
                                                                                                                                                                                       int maxElements)

Returns the list of annotations for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of annotations or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countAnnotations

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/annotations/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countAnnotations(@PathVariable
                                                                                                                                                                                         String userId,
                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                         String assetGUID)

Returns the count of annotations for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of annotations or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getCertifications

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/certifications")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CertificationsResponse getCertifications(@PathVariable
                                                                                                                                                                                                String userId,
                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                String assetGUID,
                                                                                                                                                                                                @RequestParam
                                                                                                                                                                                                int elementStart,
                                                                                                                                                                                                @RequestParam
                                                                                                                                                                                                int maxElements)

Returns the list of certifications for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of certifications or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countCertifications

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/certifications/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countCertifications(@PathVariable
                                                                                                                                                                                               String userId,
                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                               String assetGUID)

Returns the count of certifications for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of certifications or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getComments

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/comments")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CommentsResponse getComments(@PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String assetGUID,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int elementStart,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int maxElements)

Returns the list of comments for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of comments or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countComments

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/comments/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countComments(@PathVariable
                                                                                                                                                                                   String userId,
                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                   String assetGUID)

Returns the count of comments for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of comments or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getConnections

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/connections")
public org.odpi.openmetadata.accessservices.connectedasset.rest.ConnectionsResponse getConnections(@PathVariable
                                                                                                                                                                                       String userId,
                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                       String assetGUID,
                                                                                                                                                                                       @RequestParam
                                                                                                                                                                                       int elementStart,
                                                                                                                                                                                       @RequestParam
                                                                                                                                                                                       int maxElements)

Returns the list of connections for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of connections or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countConnections

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/connections/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countConnections(@PathVariable
                                                                                                                                                                                         String userId,
                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                         String assetGUID)

Returns the count of connections for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of connections or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getExternalIdentifiers

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/external-identifiers")
public org.odpi.openmetadata.accessservices.connectedasset.rest.ExternalIdentifiersResponse getExternalIdentifiers(@PathVariable
                                                                                                                                                                                                                String userId,
                                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                                String assetGUID,
                                                                                                                                                                                                                @RequestParam
                                                                                                                                                                                                                int elementStart,
                                                                                                                                                                                                                @RequestParam
                                                                                                                                                                                                                int maxElements)

Returns the list of external identifiers for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of external identifiers or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countExternalIdentifiers

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/external-identifiers/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countExternalIdentifiers(@PathVariable
                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                          String assetGUID)

Returns the count of external identifiers for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of external identifiers or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getExternalReferences

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/external-references")
public org.odpi.openmetadata.accessservices.connectedasset.rest.ExternalReferencesResponse getExternalReferences(@PathVariable
                                                                                                                                                                                                             String userId,
                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                             String assetGUID,
                                                                                                                                                                                                             @RequestParam
                                                                                                                                                                                                             int elementStart,
                                                                                                                                                                                                             @RequestParam
                                                                                                                                                                                                             int maxElements)

Returns the list of external references for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of external references or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countExternalReferences

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/external-references/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countExternalReferences(@PathVariable
                                                                                                                                                                                                        String userId,
                                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                                        String assetGUID)

Returns the count of external references for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of external references or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getInformalTags

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/informal-tags")
public org.odpi.openmetadata.accessservices.connectedasset.rest.InformalTagsResponse getInformalTags(@PathVariable
                                                                                                                                                                                           String userId,
                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                           String assetGUID,
                                                                                                                                                                                           @RequestParam
                                                                                                                                                                                           int elementStart,
                                                                                                                                                                                           @RequestParam
                                                                                                                                                                                           int maxElements)

Returns the list of informal tags for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of informal tags or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countInformalTags

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/informal-tags/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countInformalTags(@PathVariable
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String assetGUID)

Returns the count of informal tags for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of informal tags or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getLicenses

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/licenses")
public org.odpi.openmetadata.accessservices.connectedasset.rest.LicensesResponse getLicenses(@PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String assetGUID,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int elementStart,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int maxElements)

Returns the list of licenses for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of informal tags or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getLicenses

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/licenses/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse getLicenses(@PathVariable
                                                                                                                                                                                 String userId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String assetGUID)

Returns the count of licenses for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of informal tags or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getLikes

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/likes")
public org.odpi.openmetadata.accessservices.connectedasset.rest.LikesResponse getLikes(@PathVariable
                                                                                                                                                                     String userId,
                                                                                                                                                                     @PathVariable
                                                                                                                                                                     String assetGUID,
                                                                                                                                                                     @RequestParam
                                                                                                                                                                     int elementStart,
                                                                                                                                                                     @RequestParam
                                                                                                                                                                     int maxElements)

Returns the list of likes for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of likes or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countLikes

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/likes/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countLikes(@PathVariable
                                                                                                                                                                             String userId,
                                                                                                                                                                             @PathVariable
                                                                                                                                                                             String assetGUID)

Returns the count of likes for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of likes or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getKnownLocations

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/known-locations")
public org.odpi.openmetadata.accessservices.connectedasset.rest.LocationsResponse getKnownLocations(@PathVariable
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String assetGUID,
                                                                                                                                                                                            @RequestParam
                                                                                                                                                                                            int elementStart,
                                                                                                                                                                                            @RequestParam
                                                                                                                                                                                            int maxElements)

Returns the list of known locations for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of locations or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countKnownLocations

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/known-locations/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countKnownLocations(@PathVariable
                                                                                                                                                                                                String userId,
                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                String assetGUID)

Returns the count of known locations for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of locations or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getMeanings

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/meanings")
public org.odpi.openmetadata.accessservices.connectedasset.rest.MeaningsResponse getMeanings(@PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String assetGUID,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int elementStart,
                                                                                                                                                                              @RequestParam
                                                                                                                                                                              int maxElements)

Returns the list of meanings for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of meanings or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countMeanings

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/meanings/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countMeanings(@PathVariable
                                                                                                                                                                                   String userId,
                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                   String assetGUID)

Returns the count of meanings for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of meanings or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getNoteLogs

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/note-logs")
public org.odpi.openmetadata.accessservices.connectedasset.rest.NoteLogsResponse getNoteLogs(@PathVariable
                                                                                                                                                                               String userId,
                                                                                                                                                                               @PathVariable
                                                                                                                                                                               String assetGUID,
                                                                                                                                                                               @RequestParam
                                                                                                                                                                               int elementStart,
                                                                                                                                                                               @RequestParam
                                                                                                                                                                               int maxElements)

Returns the list of note logs for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of note logs or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countNoteLogs

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/note-logs/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countNoteLogs(@PathVariable
                                                                                                                                                                                    String userId,
                                                                                                                                                                                    @PathVariable
                                                                                                                                                                                    String assetGUID)

Returns the count of note logs for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of note logs or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getNotes

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/notes")
public org.odpi.openmetadata.accessservices.connectedasset.rest.NotesResponse getNotes(@PathVariable
                                                                                                                                                                     String userId,
                                                                                                                                                                     @PathVariable
                                                                                                                                                                     String assetGUID,
                                                                                                                                                                     @RequestParam
                                                                                                                                                                     int elementStart,
                                                                                                                                                                     @RequestParam
                                                                                                                                                                     int maxElements)

Returns the list of notes for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of notes or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countNotes

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/notes/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countNotes(@PathVariable
                                                                                                                                                                             String userId,
                                                                                                                                                                             @PathVariable
                                                                                                                                                                             String assetGUID)

Returns the count of notes for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of notes or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getRatings

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/ratings")
public org.odpi.openmetadata.accessservices.connectedasset.rest.RatingsResponse getRatings(@PathVariable
                                                                                                                                                                           String userId,
                                                                                                                                                                           @PathVariable
                                                                                                                                                                           String assetGUID,
                                                                                                                                                                           @RequestParam
                                                                                                                                                                           int elementStart,
                                                                                                                                                                           @RequestParam
                                                                                                                                                                           int maxElements)

Returns the list of ratings for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of ratings or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countRatings

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/ratings/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countRatings(@PathVariable
                                                                                                                                                                                 String userId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String assetGUID)

Returns the count of ratings for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of ratings or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getRelatedAssets

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/related-assets")
public org.odpi.openmetadata.accessservices.connectedasset.rest.RelatedAssetsResponse getRelatedAssets(@PathVariable
                                                                                                                                                                                              String userId,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String assetGUID,
                                                                                                                                                                                              @RequestParam
                                                                                                                                                                                              int elementStart,
                                                                                                                                                                                              @RequestParam
                                                                                                                                                                                              int maxElements)

Returns the list of related assets for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of related assets or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countRelatedAssets

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/related-assets/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countRelatedAssets(@PathVariable
                                                                                                                                                                                              String userId,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String assetGUID)

Returns the count of related assets for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of related assets or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getRelatedMediaReferences

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/related-media-references")
public org.odpi.openmetadata.accessservices.connectedasset.rest.RelatedMediaReferencesResponse getRelatedMediaReferences(@PathVariable
                                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                                          String assetGUID,
                                                                                                                                                                                                                          @RequestParam
                                                                                                                                                                                                                          int elementStart,
                                                                                                                                                                                                                          @RequestParam
                                                                                                                                                                                                                          int maxElements)

Returns the list of related media references for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a list of related media references or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

countRelatedMediaReferences

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/related-media-references/count")
public org.odpi.openmetadata.accessservices.connectedasset.rest.CountResponse countRelatedMediaReferences(@PathVariable
                                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                 String assetGUID)

Returns the count of related media references for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

Returns:

a count of related media references or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getSchema

@RequestMapping(method=GET,
                path="/assets/{assetGUID}/schema")
public org.odpi.openmetadata.accessservices.connectedasset.rest.SchemaResponse getSchema(@PathVariable
                                                                                                                                                                        String userId,
                                                                                                                                                                        @PathVariable
                                                                                                                                                                        String assetGUID,
                                                                                                                                                                        @RequestParam
                                                                                                                                                                        int elementStart,
                                                                                                                                                                        @RequestParam
                                                                                                                                                                        int maxElements)

Returns the schema for the asset.

Parameters:

userId - String userId of user making request.

assetGUID - String unique id for asset.

elementStart - int starting position for fist returned element.

maxElements - int maximum number of elements to return on the call.

Returns:

a schema or InvalidParameterException - the GUID is not recognized or the paging values are invalid or UnrecognizedAssetGUIDException - the GUID is null or invalid or PropertyServerException - there is a problem retrieving the asset properties from the property server or UserNotAuthorizedException - the requesting user is not authorized to issue this request.