AssetConsumerOMASResource (Asset Consumer OMAS with Spring 0.2 API)

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

```
@RestController
 @RequestMapping(value="/open-metadata/access-services/asset-consumer/users/{userId}")
public class AssetConsumerOMASResource
extends Object
```
The AssetConsumerRESTServices provides the server-side implementation of the AssetConsumer 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

AssetConsumerOMASResource()
Default constructor

Constructors
Constructor and Description
`AssetConsumerOMASResource()` Default constructor

Method Summary

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

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

Method Detail

getConnectionByName

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

Returns the connection object corresponding to the supplied connection name.

Parameters:: userId - userId of user making request.; name - this may be the qualifiedName or displayName of the connection.
Returns:: ConnectionResponse 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.

getConnectionByGUID

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

Returns the connection object corresponding to the supplied connection GUID.

Parameters:: userId - userId of user making request.; guid - the unique id for the connection within the property server.
Returns:: ConnectionResponse 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.

getAssetForConnection

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

Returns the unique identifier for the asset connected to the connection.

Parameters:: 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.

getMyProfile

@RequestMapping(method=GET,
                path="/my-profile")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.MyProfileResponse getMyProfile(@PathVariable
                                                                                                                                                              String userId)

Return the profile for this user.

Parameters:: userId - userId of the user making the request.
Returns:: profile response object or InvalidParameterException the userId is null or invalid or NoProfileForUserException the user does not have a profile 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.

updateMyProfile
```
@RequestMapping(method=POST,
                path="/my-profile")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse updateMyProfile(String userId,
                                                                                                                                                             org.odpi.openmetadata.accessservices.assetconsumer.rest.MyProfileRequestBody requestBody)
```
Create or update the profile for the requesting user.

Parameters:

userId - the name of the calling user.

requestBody - properties for the new profile.

Returns:

void response 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.

getMyAssets

@RequestMapping(method=GET,
                path="/my-assets")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetListResponse getMyAssets(@PathVariable
                                                                                                                                                            String userId,
                                                                                                                                                            @RequestParam
                                                                                                                                                            int startFrom,
                                                                                                                                                            @RequestParam
                                                                                                                                                            int pageSize)

Return a list of assets that the specified user has added to their favorites list.

Parameters:: userId - userId of user making request.; startFrom - index of the list ot start from (0 for start); pageSize - maximum number of elements to return.
Returns:: list of asset details 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.

addToMyAssets

@RequestMapping(method=POST,
                path="/my-assets/{assetGUID}")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse addToMyAssets(@PathVariable
                                                                                                                                                                      String userId,
                                                                                                                                                                      @PathVariable
                                                                                                                                                                      String assetGUID,
                                                                                                                                                                      @RequestBody
                                                                                                                                                                      org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody nullRequestBody)

Add an asset to the identified user's list of favorite assets.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier of the asset.; nullRequestBody - null request body
Returns:: void response or InvalidParameterException one of the parameters is invalid or PropertyServerException there is a problem updating information in the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

removeFromMyAssets

@RequestMapping(method=POST,
                path="/my-assets/{assetGUID}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeFromMyAssets(@PathVariable
                                                                                                                                                                                  String userId,
                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                  String assetGUID,
                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                  org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody nullRequestBody)

Remove an asset from identified user's list of favorite assets.

Parameters:: userId - userId of user making request.; assetGUID - unique identifier of the asset.; nullRequestBody - null request body
Returns:: void response or InvalidParameterException one of the parameters is invalid or PropertyServerException there is a problem updating information in the property server(s) 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 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 Asset's Audit Log.

Parameters:: 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:: VoidResponse 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.

addTagToAsset

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

Adds a new public tag to the asset's properties.

Parameters:: userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - contains the name of the tag and (optional) description of the tag.
Returns:: GUIDResponse 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.

addPrivateTagToAsset

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

Adds a new private tag to the asset's properties.

Parameters:: userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - contains the name of the tag and (optional) description of the tag.
Returns:: GUIDResponse 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.

addRatingToAsset

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

Adds a rating to the asset.

Parameters:: userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - containing the StarRating and user review of asset.
Returns:: GUIDResponse 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 userId,
                                                                                                                                                                      @PathVariable
                                                                                                                                                                      String guid,
                                                                                                                                                                      @RequestBody
                                                                                                                                                                      org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)

Adds a "Like" to the asset.

Parameters:: userId - String - userId of user making request.; guid - String - unique id for the asset.; requestBody - null request body to satisfy HTTP protocol.
Returns:: GUIDResponse 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 userId,
                                                                                                                                                                            @PathVariable
                                                                                                                                                                            String guid,
                                                                                                                                                                            @RequestBody
                                                                                                                                                                            org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)

Adds a comment to the asset.

Parameters:: 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:: GUIDResponse 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.

addCommentReply

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

Adds a reply to a comment.

Parameters:: 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:: GUIDResponse 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.

removeTag

@RequestMapping(method=POST,
                path="/tags/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeTag(@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:: userId - String - userId of user making request.; guid - String - unique id for the tag.; requestBody - containing type of comment enum and the text of the comment.
Returns:: VoidResponse 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.

removePrivateTag

@RequestMapping(method=POST,
                path="/tags/private/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removePrivateTag(@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:: userId - String - userId of user making request.; guid - String - unique id for the tag.; requestBody - containing type of comment enum and the text of the comment.
Returns:: VoidResponse 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.

removeRating

@RequestMapping(method=POST,
                path="/ratings/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeRating(@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:: userId - String - userId of user making request.; guid - String - unique id for the rating object; requestBody - containing type of comment enum and the text of the comment.
Returns:: VoidResponse 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.

removeLike

@RequestMapping(method=POST,
                path="/likes/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeLike(@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:: 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:: VoidResponse 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.

removeComment

@RequestMapping(method=POST,
                path="/comments/{guid}/delete")
public org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse removeComment(@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:: 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:: VoidResponse 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.

Modifier and Type	Method and Description
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addCommentReply(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 userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.CommentRequestBody requestBody)` Adds a comment to the asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addLikeToAsset(String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody requestBody)` Adds a "Like" to the asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`addLogMessageToAsset(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`	`addPrivateTagToAsset(String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)` Adds a new private tag to the asset's properties.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addRatingToAsset(String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.RatingRequestBody requestBody)` Adds a rating to the asset.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`addTagToAsset(String userId, String guid, org.odpi.openmetadata.accessservices.assetconsumer.rest.TagRequestBody requestBody)` Adds a new public tag to the asset's properties.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`addToMyAssets(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody nullRequestBody)` Add an asset to the identified user's list of favorite assets.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.GUIDResponse`	`getAssetForConnection(String userId, String connectionGUID)` Returns the unique identifier for the asset connected to the connection.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse`	`getConnectionByGUID(String userId, String guid)` Returns the connection object corresponding to the supplied connection GUID.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.ConnectionResponse`	`getConnectionByName(String userId, String name)` Returns the connection object corresponding to the supplied connection name.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetListResponse`	`getMyAssets(String userId, int startFrom, int pageSize)` Return a list of assets that the specified user has added to their favorites list.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.MyProfileResponse`	`getMyProfile(String userId)` Return the profile for this user.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeComment(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`	`removeFromMyAssets(String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetconsumer.rest.NullRequestBody nullRequestBody)` Remove an asset from identified user's list of favorite assets.
`org.odpi.openmetadata.accessservices.assetconsumer.rest.VoidResponse`	`removeLike(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`	`removePrivateTag(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.VoidResponse`	`removeRating(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`	`removeTag(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.VoidResponse`	`updateMyProfile(String userId, org.odpi.openmetadata.accessservices.assetconsumer.rest.MyProfileRequestBody requestBody)` Create or update the profile for the requesting user.

Class AssetConsumerOMASResource

Constructor Summary