org.odpi.openmetadata.accessservices.connectedasset.server

Class ConnectedAssetRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.connectedasset.server.ConnectedAssetRESTServices

public class ConnectedAssetRESTServices
extends Object

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

Constructor Summary

Constructors

Constructor and Description
ConnectedAssetRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
CountResponse	countAnnotations(String userId, String assetGUID) Returns the count of annotations for the asset.
CountResponse	countCertifications(String userId, String assetGUID) Returns the count of certifications for the asset.
CountResponse	countComments(String userId, String assetGUID) Returns the count of comments for the asset.
CountResponse	countConnections(String userId, String assetGUID) Returns the count of connections for the asset.
CountResponse	countExternalIdentifiers(String userId, String assetGUID) Returns the count of external identifiers for the asset.
CountResponse	countExternalReferences(String userId, String assetGUID) Returns the count of external references for the asset.
CountResponse	countInformalTags(String userId, String assetGUID) Returns the count of informal tags for the asset.
CountResponse	countKnownLocations(String userId, String assetGUID) Returns the count of known locations for the asset.
CountResponse	countLicenses(String userId, String assetGUID) Returns the count of licenses for the asset.
CountResponse	countLikes(String userId, String assetGUID) Returns the count of likes for the asset.
CountResponse	countMeanings(String userId, String assetGUID) Returns the count of meanings for the asset.
CountResponse	countNoteLogs(String userId, String assetGUID) Returns the count of note logs for the asset.
CountResponse	countNotes(String userId, String assetGUID) Returns the count of notes for the asset.
CountResponse	countRatings(String userId, String assetGUID) Returns the count of ratings for the asset.
CountResponse	countRelatedAssets(String userId, String assetGUID) Returns the count of related assets for the asset.
CountResponse	countRelatedMediaReferences(String userId, String assetGUID) Returns the count of related media references for the asset.
AnnotationsResponse	getAnnotations(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of annotations for the asset.
GUIDResponse	getAssetIdForConnection(String userId, String connectionGUID) Returns the basic information about the asset.
AssetResponse	getAssetSummary(String userId, String assetGUID) Returns the basic information about the asset.
CertificationsResponse	getCertifications(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of certifications for the asset.
CommentsResponse	getCommentReplies(String userId, String commentGUID, int elementStart, int maxElements) Returns the list of replies to a comment.
CommentsResponse	getComments(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of comments for the asset.
ConnectionsResponse	getConnections(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of connections for the asset.
ExternalIdentifiersResponse	getExternalIdentifiers(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of external identifiers for the asset.
ExternalReferencesResponse	getExternalReferences(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of external references for the asset.
InformalTagsResponse	getInformalTags(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of informal tags for the asset.
LocationsResponse	getKnownLocations(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of known locations for the asset.
LicensesResponse	getLicenses(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of licenses for the asset.
LikesResponse	getLikes(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of likes for the asset.
MeaningsResponse	getMeanings(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of meanings for the asset.
NoteLogsResponse	getNoteLogs(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of note logs for the asset.
NotesResponse	getNotes(String userId, String noteLogGUID, int elementStart, int maxElements) Returns the list of notes for a note log.
RatingsResponse	getRatings(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of ratings for the asset.
RelatedAssetsResponse	getRelatedAssets(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of related assets for the asset.
RelatedMediaReferencesResponse	getRelatedMediaReferences(String userId, String assetGUID, int elementStart, int maxElements) Returns the list of related media references for the asset.
SchemaResponse	getSchema(String userId, String assetGUID, int elementStart, int maxElements) Returns the schema for the asset.
static void	setRepositoryConnector(String accessServiceName, OMRSRepositoryConnector repositoryConnector) Provide a connector to the REST Services.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConnectedAssetRESTServices

public ConnectedAssetRESTServices()

Default constructor

Method Detail

setRepositoryConnector

public static void setRepositoryConnector(String accessServiceName,
                                          OMRSRepositoryConnector repositoryConnector)

Provide a connector to the REST Services.

Parameters:

accessServiceName - name of this access service

repositoryConnector - OMRS Repository Connector to the property server.

getAssetSummary

public AssetResponse getAssetSummary(String userId,
                                     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.

getAssetIdForConnection

public GUIDResponse getAssetIdForConnection(String userId,
                                            String connectionGUID)

Returns the basic information about the asset.

Parameters:

userId - userId of user making request.

connectionGUID - unique id for connection.

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

public AnnotationsResponse getAnnotations(String userId,
                                          String assetGUID,
                                          int elementStart,
                                          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

public CountResponse countAnnotations(String userId,
                                      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

public CertificationsResponse getCertifications(String userId,
                                                String assetGUID,
                                                int elementStart,
                                                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

public CountResponse countCertifications(String userId,
                                         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

public CommentsResponse getComments(String userId,
                                    String assetGUID,
                                    int elementStart,
                                    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.

getCommentReplies

public CommentsResponse getCommentReplies(String userId,
                                          String commentGUID,
                                          int elementStart,
                                          int maxElements)

Returns the list of replies to a comment.

Parameters:

userId - String userId of user making request.

commentGUID - String unique id for root comment.

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

public CountResponse countComments(String userId,
                                   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

public ConnectionsResponse getConnections(String userId,
                                          String assetGUID,
                                          int elementStart,
                                          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

public CountResponse countConnections(String userId,
                                      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

public ExternalIdentifiersResponse getExternalIdentifiers(String userId,
                                                          String assetGUID,
                                                          int elementStart,
                                                          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

public CountResponse countExternalIdentifiers(String userId,
                                              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

public ExternalReferencesResponse getExternalReferences(String userId,
                                                        String assetGUID,
                                                        int elementStart,
                                                        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

public CountResponse countExternalReferences(String userId,
                                             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

public InformalTagsResponse getInformalTags(String userId,
                                            String assetGUID,
                                            int elementStart,
                                            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

public CountResponse countInformalTags(String userId,
                                       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

public LicensesResponse getLicenses(String userId,
                                    String assetGUID,
                                    int elementStart,
                                    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 licenses 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.

countLicenses

public CountResponse countLicenses(String userId,
                                   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 license 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

public LikesResponse getLikes(String userId,
                              String assetGUID,
                              int elementStart,
                              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

public CountResponse countLikes(String userId,
                                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

public LocationsResponse getKnownLocations(String userId,
                                           String assetGUID,
                                           int elementStart,
                                           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 known 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

public CountResponse countKnownLocations(String userId,
                                         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 known 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

public MeaningsResponse getMeanings(String userId,
                                    String assetGUID,
                                    int elementStart,
                                    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

public CountResponse countMeanings(String userId,
                                   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

public NoteLogsResponse getNoteLogs(String userId,
                                    String assetGUID,
                                    int elementStart,
                                    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

public CountResponse countNoteLogs(String userId,
                                   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

public NotesResponse getNotes(String userId,
                              String noteLogGUID,
                              int elementStart,
                              int maxElements)

Returns the list of notes for a note log.

Parameters:

userId - String userId of user making request.

noteLogGUID - String unique id for the note log.

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

public CountResponse countNotes(String userId,
                                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

public RatingsResponse getRatings(String userId,
                                  String assetGUID,
                                  int elementStart,
                                  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

public CountResponse countRatings(String userId,
                                  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

public RelatedAssetsResponse getRelatedAssets(String userId,
                                              String assetGUID,
                                              int elementStart,
                                              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 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

public CountResponse countRelatedAssets(String userId,
                                        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

public RelatedMediaReferencesResponse getRelatedMediaReferences(String userId,
                                                                String assetGUID,
                                                                int elementStart,
                                                                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

public CountResponse countRelatedMediaReferences(String userId,
                                                 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

public SchemaResponse getSchema(String userId,
                                String assetGUID,
                                int elementStart,
                                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 list of 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.