@RestController
@RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-consumer/users/{userId}")
public class AssetConsumerResource
extends Object
| Constructor and Description |
|---|
AssetConsumerResource()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
GUIDResponse |
addCommentReply(String serverName,
String userId,
String assetGUID,
String commentGUID,
CommentRequestBody requestBody)
Adds a reply to a comment.
|
GUIDResponse |
addCommentToAsset(String serverName,
String userId,
String assetGUID,
CommentRequestBody requestBody)
Creates a comment and attaches it to an asset.
|
VoidResponse |
addLikeToAsset(String serverName,
String userId,
String assetGUID,
FeedbackRequestBody requestBody)
Creates a "like" object and attaches it to an asset.
|
VoidResponse |
addLogMessageToAsset(String serverName,
String userId,
String assetGUID,
LogRecordRequestBody requestBody)
Creates an audit log record for the asset.
|
VoidResponse |
addRatingToAsset(String serverName,
String userId,
String assetGUID,
RatingRequestBody requestBody)
Adds a star rating and optional review text to the asset.
|
VoidResponse |
addTagToAsset(String serverName,
String userId,
String assetGUID,
String tagGUID,
FeedbackRequestBody requestBody)
Adds a tag (either private of public) to an asset.
|
GUIDResponse |
createTag(String serverName,
String userId,
TagRequestBody requestBody)
Creates a new informal tag and returns the unique identifier for it.
|
VoidResponse |
deleteTag(String serverName,
String userId,
String tagGUID,
NullRequestBody requestBody)
Removes a tag from the repository.
|
GUIDListResponse |
findAssets(String serverName,
String userId,
int startFrom,
int pageSize,
String searchString)
Return a list of assets with the requested search string in their name, qualified name
or description.
|
GlossaryTermListResponse |
findMeanings(String serverName,
String userId,
int startFrom,
int pageSize,
String name)
Return the full definition (meaning) of the terms matching the supplied name.
|
TagsResponse |
findMyTags(String serverName,
String userId,
int startFrom,
int pageSize,
String tagName)
Return the list of the calling user's private tags containing the supplied string in either the name or description.
|
TagsResponse |
findTags(String serverName,
String userId,
int startFrom,
int pageSize,
String tagName)
Return the list of tags containing the supplied string in either the name or description.
|
GUIDResponse |
getAssetForConnectionName(String serverName,
String userId,
String connectionName)
Returns the unique identifier for the asset connected to the connection identified by the supplied name.
|
GUIDListResponse |
getAssetsByMeaning(String serverName,
String userId,
String termGUID,
int startFrom,
int pageSize)
Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via
fields in the schema.
|
GUIDListResponse |
getAssetsByName(String serverName,
String userId,
int startFrom,
int pageSize,
String name)
Return a list of assets with the requested name.
|
ConnectionResponse |
getConnectionByName(String serverName,
String userId,
String name)
Returns the connection object corresponding to the supplied connection name.
|
GlossaryTermResponse |
getMeaning(String serverName,
String userId,
String termGUID)
Return the full definition (meaning) of a term using the unique identifier of the glossary term.
|
GlossaryTermListResponse |
getMeaningByName(String serverName,
String userId,
int startFrom,
int pageSize,
String name)
Return the full definition (meaning) of the terms exactly matching the supplied name.
|
TagsResponse |
getMyTagsByName(String serverName,
String userId,
int startFrom,
int pageSize,
String tagName)
Return the list of the calling user's private tags exactly matching the supplied name.
|
TagResponse |
getTag(String serverName,
String userId,
String tagGUID)
Return the Informal Tag for the supplied unique identifier (assetGUID).
|
TagsResponse |
getTagsByName(String serverName,
String userId,
int startFrom,
int pageSize,
String tagName)
Return the tags exactly matching the supplied name.
|
VoidResponse |
removeCommentFromAsset(String serverName,
String userId,
String assetGUID,
String commentGUID,
NullRequestBody requestBody)
Removes a comment added to the asset by this user.
|
VoidResponse |
removeLikeFromAsset(String serverName,
String userId,
String assetGUID,
NullRequestBody requestBody)
Removes a "Like" added to the asset by this user.
|
VoidResponse |
removeRatingFromAsset(String serverName,
String userId,
String assetGUID,
NullRequestBody requestBody)
Removes of a star rating that was added to the asset by this user.
|
VoidResponse |
removeTagFromAsset(String serverName,
String userId,
String assetGUID,
String tagGUID,
NullRequestBody requestBody)
Removes a link between a tag and an asset that was added by this user.
|
VoidResponse |
updateComment(String serverName,
String userId,
String assetGUID,
String commentGUID,
CommentRequestBody requestBody)
Update an existing comment.
|
VoidResponse |
updateTagDescription(String serverName,
String userId,
String tagGUID,
TagRequestBody requestBody)
Updates the description of an existing tag (either private or public).
|
@PostMapping(path="/assets/{assetGUID}/comments/{commentGUID}/replies")
public GUIDResponse addCommentReply(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String commentGUID,
@RequestBody
CommentRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - String - unique id of asset that this chain of comments is linked.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.@PostMapping(path="/assets/{assetGUID}/comments")
public GUIDResponse addCommentToAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
CommentRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - String - unique id for the asset.requestBody - containing type of comment enum and the text of the comment.@PostMapping(path="/assets/{assetGUID}/likes")
public VoidResponse addLikeToAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
FeedbackRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - String - unique id for the asset.requestBody - feedback request body.@PostMapping(path="/assets/{assetGUID}/log-records")
public VoidResponse addLogMessageToAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
LogRecordRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - 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).@PostMapping(path="/assets/{assetGUID}/ratings")
public VoidResponse addRatingToAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
RatingRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - String - unique id for the asset.requestBody - containing the StarRating and user review of asset.@PostMapping(path="/assets/{assetGUID}/tags/{tagGUID}")
public VoidResponse addTagToAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String tagGUID,
@RequestBody
FeedbackRequestBody requestBody)
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.@PostMapping(path="/tags") public GUIDResponse createTag(@PathVariable String serverName, @PathVariable String userId, @RequestBody TagRequestBody requestBody)
serverName - name of the server instances for this request.userId - userId of user making request.requestBody - public/private flag, name of the tag and (optional) description of the tag.@PostMapping(path="/tags/{tagGUID}/delete")
public VoidResponse deleteTag(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String tagGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of the server instances for this requestuserId - String - userId of user making request.tagGUID - String - unique id for the tag.requestBody - null request body.@GetMapping(path="/assets/by-connection-name/{connectionName}")
public GUIDResponse getAssetForConnectionName(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String connectionName)
serverName - name of the server instances for this request.userId - the userId of the requesting user.connectionName - uniqueId for the connection.@PostMapping(path="/assets/by-search-string") public GUIDListResponse findAssets(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String searchString)
serverName - name of the server instances for this requestuserId - calling usersearchString - string to search for in textstartFrom - starting element (used in paging through large result sets)pageSize - maximum number of results to return@GetMapping(path="/assets/by-meaning/{termGUID}")
public GUIDListResponse getAssetsByMeaning(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String termGUID,
@RequestParam
int startFrom,
@RequestParam
int pageSize)
serverName - name of the server instances for this requestuserId - the name of the calling user.termGUID - unique identifier of term.startFrom - index of the list to start from (0 for start)pageSize - maximum number of elements to return.@PostMapping(path="/assets/by-name") public GUIDListResponse getAssetsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String name)
serverName - name of the server instances for this requestuserId - calling username - name to search forstartFrom - starting element (used in paging through large result sets)pageSize - maximum number of results to return@GetMapping(path="/connections/by-name/{name}")
public ConnectionResponse getConnectionByName(@PathVariable
String serverName,
@PathVariable
String userId,
@RequestBody
String name)
serverName - name of the server instances for this requestuserId - userId of user making request.name - this may be the qualifiedName or displayName of the connection.@PostMapping(path="/meanings/by-name") public GlossaryTermListResponse getMeaningByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String name)
serverName - name of the server instances for this request.userId - the name of the calling user.name - name of term.startFrom - index of the list to start from (0 for start).pageSize - maximum number of elements to return.@PostMapping(path="/meanings/by-search-string") public GlossaryTermListResponse findMeanings(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String name)
serverName - name of the server instances for this request.userId - the name of the calling user.name - name of term. This may include wild card characters.startFrom - index of the list to start from (0 for start).pageSize - maximum number of elements to return.@GetMapping(path="/meanings/{termGUID}")
public GlossaryTermResponse getMeaning(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String termGUID)
serverName - name of the server instances for this request.userId - userId of the user making the request.termGUID - unique identifier of the glossary term that contains the meaning.@GetMapping(path="/tags/{tagGUID}")
public TagResponse getTag(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String tagGUID)
serverName - name of the server instances for this request.userId - userId of the user making the request.tagGUID - unique identifier of the meaning.@PostMapping(path="/tags/by-name") public TagsResponse getTagsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String tagName)
serverName - name of the server instances for this request.userId - the name of the calling user.tagName - name of tag.startFrom - index of the list to start from (0 for start).pageSize - maximum number of elements to return.@PostMapping(path="/tags/private/by-name") public TagsResponse getMyTagsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String tagName)
serverName - name of the server instances for this request.userId - the name of the calling user.tagName - name of tag.startFrom - index of the list to start from (0 for start).pageSize - maximum number of elements to return.@PostMapping(path="/tags/by-search-string") public TagsResponse findTags(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String tagName)
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 to start from (0 for start).pageSize - maximum number of elements to return.@PostMapping(path="/tags/private/by-search-string") public TagsResponse findMyTags(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody String tagName)
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 to start from (0 for start).pageSize - maximum number of elements to return.@PostMapping(path="/assets/{assetGUID}/comments/{commentGUID}/delete")
public VoidResponse removeCommentFromAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String commentGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of the server instances for this requestuserId - String - userId of user making request.assetGUID - String - unique id for the asset objectcommentGUID - String - unique id for the comment objectrequestBody - containing type of comment enum and the text of the comment.@PostMapping(path="/assets/{assetGUID}/likes/delete")
public VoidResponse removeLikeFromAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - unique identifier for the asset where the like is attached.requestBody - containing type of comment enum and the text of the comment.@PostMapping(path="/assets/{assetGUID}/ratings/delete")
public VoidResponse removeRatingFromAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@RequestBody
NullRequestBody requestBody)
serverName - name of the server instances for this request.userId - String - userId of user making request.assetGUID - unique identifier for the asset where the rating is attached.requestBody - containing type of comment enum and the text of the comment.@PostMapping(path="/assets/{assetGUID}/tags/{tagGUID}/delete")
public VoidResponse removeTagFromAsset(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String tagGUID,
@RequestBody
NullRequestBody requestBody)
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.@PostMapping(path="assets/{assetGUID}/comments/{commentGUID}/update")
public VoidResponse updateComment(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String assetGUID,
@PathVariable
String commentGUID,
@RequestBody
CommentRequestBody requestBody)
serverName - name of the server instances for this request.userId - userId of user making request.assetGUID - unique identifier for the asset that the comment is attached to (directly or indirectly).commentGUID - unique identifier for the comment to change.requestBody - containing type of comment enum and the text of the comment.@PostMapping(path="/tags/{tagGUID}/update")
public VoidResponse updateTagDescription(@PathVariable
String serverName,
@PathVariable
String userId,
@PathVariable
String tagGUID,
@RequestBody
TagRequestBody requestBody)
serverName - name of the server instances for this requestuserId - userId of user making request.tagGUID - unique id for the tag.requestBody - contains the name of the tag and (optional) description of the tag.Copyright © 2018–2020 ODPi. All rights reserved.