AssetConsumerResource (Asset Consumer OMAS with Spring 1.0 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.assetconsumer.server.spring.AssetConsumerResource

```
@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-consumer/users/{userId}")
public class AssetConsumerResource
extends Object
```
The AssetConsumerOMASResource provides the server-side implementation of the Asset Consumer Open Metadata Assess Service (OMAS). This interface provides connections to assets and APIs for adding feedback on the asset.

Constructor Summary

Constructors
Constructor and Description

AssetConsumerResource()
Default constructor

Constructors
Constructor and Description
`AssetConsumerResource()` Default constructor

Method Summary

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AssetConsumerResource
```
public AssetConsumerResource()
```
  Default constructor

Method Detail

addCommentReply

@RequestMapping(method=POST,
                path="/comments/{commentGUID}/replies")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse addCommentReply(@PathVariable
                                                                                                                                                                                 String serverName,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String userId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String commentGUID,
                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                 org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)

Adds a reply to a comment.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.; requestBody - containing type of comment enum and the text of the comment.
Returns:: guid for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addCommentToAsset

@RequestMapping(method=POST,
                path="/assets/{guid}/comments")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse addCommentToAsset(@PathVariable
                                                                                                                                                                           String serverName,
                                                                                                                                                                           @PathVariable
                                                                                                                                                                           String userId,
                                                                                                                                                                           @PathVariable
                                                                                                                                                                           String guid,
                                                                                                                                                                           @RequestBody
                                                                                                                                                                           org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)

Creates a comment and attaches it to an asset.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - containing type of comment enum and the text of the comment.
Returns:: guid for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addLikeToAsset

@RequestMapping(method=POST,
                path="/assets/{guid}/likes")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse addLikeToAsset(@PathVariable
                                                                                                                                                                     String serverName,
                                                                                                                                                                     @PathVariable
                                                                                                                                                                     String userId,
                                                                                                                                                                     @PathVariable
                                                                                                                                                                     String guid,
                                                                                                                                                                     @RequestBody
                                                                                                                                                                     org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Creates a "like" object and attaches it to an asset.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - null request body to satisfy HTTP protocol.
Returns:: guid for new like object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addLogMessageToAsset

@RequestMapping(method=POST,
                path="/assets/{guid}/log-records")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse addLogMessageToAsset(@PathVariable
                                                                                                                                                                                 String serverName,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String userId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String guid,
                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                 org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody requestBody)

Creates an audit log record for the asset. This log record is stored in the local server's Audit Log.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - containing: connectorInstanceId (String - (optional) id of connector in use (if any)), connectionName (String - (optional) name of the connection (extracted from the connector)), connectorType (String - (optional) type of connector in use (if any)), contextId (String - (optional) function name, or processId of the activity that the caller is performing), message (log record content).
Returns:: void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the log message to the audit log for this asset or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

addReviewToAsset

@RequestMapping(method=POST,
                path="/assets/{guid}/reviews")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse addReviewToAsset(@PathVariable
                                                                                                                                                                         String serverName,
                                                                                                                                                                         @PathVariable
                                                                                                                                                                         String userId,
                                                                                                                                                                         @PathVariable
                                                                                                                                                                         String guid,
                                                                                                                                                                         @RequestBody
                                                                                                                                                                         org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody requestBody)

Adds a star rating and optional review text to the asset.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - containing the StarRating and user review of asset.
Returns:: guid for new review object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

addTagToAsset

@RequestMapping(method=POST,
                path="/assets/{assetGUID}/tags/{tagGUID}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse addTagToAsset(@PathVariable
                                                                                                                                                                                  String serverName,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String userId,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String assetGUID,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String tagGUID,
                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                  org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Adds a tag (either private of public) to an asset.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; assetGUID - unique id for the asset.; tagGUID - unique id of the tag.; requestBody - null request body needed for correct protocol exchange.
Returns:: void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

createPrivateTag

@RequestMapping(method=POST,
                path="/tags/private")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse createPrivateTag(@PathVariable
                                                                                                                                                                String serverName,
                                                                                                                                                                @PathVariable
                                                                                                                                                                String userId,
                                                                                                                                                                @RequestBody
                                                                                                                                                                org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)

Creates a new private informal tag and returns the unique identifier for it.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; requestBody - name of the tag and (optional) description of the tag.
Returns:: new guid or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

createPublicTag

@RequestMapping(method=POST,
                path="/tags/public")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse createPublicTag(@PathVariable
                                                                                                                                                              String serverName,
                                                                                                                                                              @PathVariable
                                                                                                                                                              String userId,
                                                                                                                                                              @RequestBody
                                                                                                                                                              org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)

Creates a new public informal tag and returns the unique identifier for it.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; requestBody - name of the tag and (optional) description of the tag. Setting a description, particularly in a public tag makes the tag more valuable to other users and can act as an embryonic glossary term.
Returns:: new guid or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the asset properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

deleteTag

@RequestMapping(method=POST,
                path="/tags/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse deleteTag(@PathVariable
                                                                                                                                                               String serverName,
                                                                                                                                                               @PathVariable
                                                                                                                                                               String userId,
                                                                                                                                                               @PathVariable
                                                                                                                                                               String guid,
                                                                                                                                                               @RequestBody
                                                                                                                                                               org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Removes a tag from the asset that was added by this user.

Parameters:: serverName - name of the server instances for this request; userId - String - userId of user making request.; guid - String - unique id for the tag.; requestBody - null request body.
Returns:: void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the asset properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getAssetForConnectionGUID

@RequestMapping(method=GET,
                path="/assets/by-connection/{connectionGUID}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse getAssetForConnectionGUID(@PathVariable
                                                                                                                                                                                                 String serverName,
                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                 String connectionGUID)

Returns the unique identifier for the asset connected to the connection identified by the supplied guid.

Parameters:: serverName - name of the server instances for this request.; userId - the userId of the requesting user.; connectionGUID - uniqueId for the connection.
Returns:: unique identifier of asset or InvalidParameterException one of the parameters is null or invalid or PropertyServerException there is a problem retrieving the connected asset properties from the property server or UnrecognizedConnectionGUIDException the supplied GUID is not recognized by the property server or NoConnectedAssetException there is no asset associated with this connection or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getAssetForConnectionName

@RequestMapping(method=GET,
                path="/assets/by-connection-name/{connectionName}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse getAssetForConnectionName(@PathVariable
                                                                                                                                                                                                      String serverName,
                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                      String userId,
                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                      String connectionName)

Returns the unique identifier for the asset connected to the connection identified by the supplied name.

Parameters:: serverName - name of the server instances for this request.; userId - the userId of the requesting user.; connectionName - uniqueId for the connection.
Returns:: unique identifier of asset or InvalidParameterException one of the parameters is null or invalid or PropertyServerException there is a problem retrieving the connected asset properties from the property server or UnrecognizedConnectionGUIDException the supplied GUID is not recognized by the property server or NoConnectedAssetException there is no asset associated with this connection or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getConnectionByGUID

@RequestMapping(method=GET,
                path="/connections/{guid}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse getConnectionByGUID(@PathVariable
                                                                                                                                                                              String serverName,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String guid)

Returns the connection object corresponding to the supplied connection GUID.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; guid - the unique id for the connection within the property server.
Returns:: connection object or InvalidParameterException one of the parameters is null or invalid or UnrecognizedConnectionGUIDException the supplied GUID is not recognized by the metadata repository or PropertyServerException there is a problem retrieving information from the property (metadata) server or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getConnectionByName

@RequestMapping(method=GET,
                path="/connections/by-name/{name}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse getConnectionByName(@PathVariable
                                                                                                                                                                                      String serverName,
                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                      String userId,
                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                      String name)

Returns the connection object corresponding to the supplied connection name.

Parameters:: serverName - name of the server instances for this request; userId - userId of user making request.; name - this may be the qualifiedName or displayName of the connection.
Returns:: connection object or InvalidParameterException one of the parameters is null or invalid or UnrecognizedConnectionNameException there is no connection defined for this name or AmbiguousConnectionNameException there is more than one connection defined for this name or PropertyServerException there is a problem retrieving information from the property (metadata) server or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getMeaningByName

@RequestMapping(method=GET,
                path="/meanings/by-name/{term}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse getMeaningByName(@PathVariable
                                                                                                                                                                                 String serverName,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String userId,
                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                 String term,
                                                                                                                                                                                 @RequestParam
                                                                                                                                                                                 int startFrom,
                                                                                                                                                                                 @RequestParam
                                                                                                                                                                                 int pageSize)

Return the full definition (meaning) of the terms matching the supplied name.

Parameters:: serverName - name of the server instances for this request.; userId - the name of the calling user.; term - name of term. This may include wild card characters.; startFrom - index of the list ot start from (0 for start).; pageSize - maximum number of elements to return.
Returns:: list of meaning objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getMeaning

@RequestMapping(method=GET,
                path="/meanings/{guid}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse getMeaning(@PathVariable
                                                                                                                                                               String serverName,
                                                                                                                                                               @PathVariable
                                                                                                                                                               String userId,
                                                                                                                                                               @PathVariable
                                                                                                                                                               String guid)

Return the full definition (meaning) of a term using the unique identifier of the glossary term.

Parameters:: serverName - name of the server instances for this request.; userId - userId of the user making the request.; guid - unique identifier of the meaning.
Returns:: meaning object or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getTag

@RequestMapping(method=GET,
                path="/tags/{guid}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse getTag(@PathVariable
                                                                                                                                                   String serverName,
                                                                                                                                                   @PathVariable
                                                                                                                                                   String userId,
                                                                                                                                                   @PathVariable
                                                                                                                                                   String guid)

Return the Informal Tag for the supplied unique identifier (guid).

Parameters:: serverName - name of the server instances for this request.; userId - userId of the user making the request.; guid - unique identifier of the meaning.
Returns:: tag object or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

getTagsByName

@RequestMapping(method=GET,
                path="/tags/by-name/{tagName}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse getTagsByName(@PathVariable
                                                                                                                                                                         String serverName,
                                                                                                                                                                         @PathVariable
                                                                                                                                                                         String userId,
                                                                                                                                                                         @PathVariable
                                                                                                                                                                         String tagName,
                                                                                                                                                                         @RequestParam
                                                                                                                                                                         int startFrom,
                                                                                                                                                                         @RequestParam
                                                                                                                                                                         int pageSize)

Return the tags matching the supplied name.

Parameters:: serverName - name of the server instances for this request.; userId - the name of the calling user.; tagName - name of tag. This may include wild card characters.; startFrom - index of the list ot start from (0 for start).; pageSize - maximum number of elements to return.
Returns:: list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeCommentFromAsset

@RequestMapping(method=POST,
                path="/comments/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeCommentFromAsset(@PathVariable
                                                                                                                                                                                String serverName,
                                                                                                                                                                                @PathVariable
                                                                                                                                                                                String userId,
                                                                                                                                                                                @PathVariable
                                                                                                                                                                                String guid,
                                                                                                                                                                                @RequestBody
                                                                                                                                                                                org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Removes a comment added to the asset by this user.

Parameters:: serverName - name of the server instances for this request; userId - String - userId of user making request.; guid - String - unique id for the comment object; requestBody - containing type of comment enum and the text of the comment.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the user does not have permission to perform this request.

removeLikeFromAsset

@RequestMapping(method=POST,
                path="/likes/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeLikeFromAsset(@PathVariable
                                                                                                                                                                          String serverName,
                                                                                                                                                                          @PathVariable
                                                                                                                                                                          String userId,
                                                                                                                                                                          @PathVariable
                                                                                                                                                                          String guid,
                                                                                                                                                                          @RequestBody
                                                                                                                                                                          org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Removes a "Like" added to the asset by this user.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - String - unique id for the like object.; requestBody - containing type of comment enum and the text of the comment.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeReviewFromAsset

@RequestMapping(method=POST,
                path="/reviews/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeReviewFromAsset(@PathVariable
                                                                                                                                                                              String serverName,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String guid,
                                                                                                                                                                              @RequestBody
                                                                                                                                                                              org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Removes of a star rating that was added to the asset by this user.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; guid - unique id for the review.; requestBody - containing type of comment enum and the text of the comment.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeTagFromAsset

@RequestMapping(method=POST,
                path="/assets/{assetGUID}/tags/{tagGUID}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeTagFromAsset(@PathVariable
                                                                                                                                                                                              String serverName,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String userId,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String assetGUID,
                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                              String tagGUID,
                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                              org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Removes a link between a tag and an asset that was added by this user.

Parameters:: serverName - name of the server instances for this request.; userId - String - userId of user making request.; assetGUID - unique id for the asset.; tagGUID - unique id of the tag.; requestBody - null request body needed for correct protocol exchange.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateComment

@RequestMapping(method=POST,
                path="/comments/{commentGUID}/update")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse updateComment(@PathVariable
                                                                                                                                                                              String serverName,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String userId,
                                                                                                                                                                              @PathVariable
                                                                                                                                                                              String commentGUID,
                                                                                                                                                                              @RequestBody
                                                                                                                                                                              org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)

Update an existing comment.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; commentGUID - unique identifier for the comment to change.; requestBody - containing type of comment enum and the text of the comment.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateReviewOnAsset

@RequestMapping(method=POST,
                path="/reviews/{reviewGUID}/update")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse updateReviewOnAsset(@PathVariable
                                                                                                                                                                                  String serverName,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String userId,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String reviewGUID,
                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                  org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody requestBody)

Updates the rating and optional review text attached to the asset by this user.

Parameters:: serverName - name of the server instances for this request.; userId - userId of user making request.; reviewGUID - unique identifier for the review.; requestBody - provides the StarRating enumeration for none, one to five stars plus optional review test.
Returns:: void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the asset properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

updateTagDescription

@RequestMapping(method=POST,
                path="/tags/{tagGUID}/update")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse updateTagDescription(@PathVariable
                                                                                                                                                                             String serverName,
                                                                                                                                                                             @PathVariable
                                                                                                                                                                             String userId,
                                                                                                                                                                             @PathVariable
                                                                                                                                                                             String tagGUID,
                                                                                                                                                                             @RequestBody
                                                                                                                                                                             org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)

Updates the description of an existing tag (either private of public).

Parameters:: serverName - name of the server instances for this request; userId - userId of user making request.; tagGUID - unique id for the tag.; requestBody - contains the name of the tag and (optional) description of the tag.
Returns:: void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

Modifier and Type	Method and Description
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addCommentReply(String serverName, String userId, String commentGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)` Adds a reply to a comment.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addCommentToAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)` Creates a comment and attaches it to an asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addLikeToAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Creates a "like" object and attaches it to an asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`addLogMessageToAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody requestBody)` Creates an audit log record for the asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addReviewToAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody requestBody)` Adds a star rating and optional review text to the asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`addTagToAsset(String serverName, String userId, String assetGUID, String tagGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Adds a tag (either private of public) to an asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`createPrivateTag(String serverName, String userId, org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)` Creates a new private informal tag and returns the unique identifier for it.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`createPublicTag(String serverName, String userId, org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)` Creates a new public informal tag and returns the unique identifier for it.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`deleteTag(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Removes a tag from the asset that was added by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`getAssetForConnectionGUID(String serverName, String userId, String connectionGUID)` Returns the unique identifier for the asset connected to the connection identified by the supplied guid.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`getAssetForConnectionName(String serverName, String userId, String connectionName)` Returns the unique identifier for the asset connected to the connection identified by the supplied name.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse`	`getConnectionByGUID(String serverName, String userId, String guid)` Returns the connection object corresponding to the supplied connection GUID.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse`	`getConnectionByName(String serverName, String userId, String name)` Returns the connection object corresponding to the supplied connection name.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningResponse`	`getMeaning(String serverName, String userId, String guid)` Return the full definition (meaning) of a term using the unique identifier of the glossary term.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.MeaningListResponse`	`getMeaningByName(String serverName, String userId, String term, int startFrom, int pageSize)` Return the full definition (meaning) of the terms matching the supplied name.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse`	`getTag(String serverName, String userId, String guid)` Return the Informal Tag for the supplied unique identifier (guid).
`org.odpi.openmetadata.accessservices.assetconsumer.rest.TagListResponse`	`getTagsByName(String serverName, String userId, String tagName, int startFrom, int pageSize)` Return the tags matching the supplied name.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeCommentFromAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Removes a comment added to the asset by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeLikeFromAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Removes a "Like" added to the asset by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeReviewFromAsset(String serverName, String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Removes of a star rating that was added to the asset by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeTagFromAsset(String serverName, String userId, String assetGUID, String tagGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Removes a link between a tag and an asset that was added by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`updateComment(String serverName, String userId, String commentGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)` Update an existing comment.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`updateReviewOnAsset(String serverName, String userId, String reviewGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.ReviewRequestBody requestBody)` Updates the rating and optional review text attached to the asset by this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`updateTagDescription(String serverName, String userId, String tagGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)` Updates the description of an existing tag (either private of public).

Class AssetConsumerResource

Constructor Summary