Class FeedbackManagerResource
java.lang.Object
org.odpi.openmetadata.viewservices.feedbackmanager.server.spring.FeedbackManagerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class FeedbackManagerResource
extends Object
The FeedbackManagerResource provides the Spring API endpoints of the Feedback Manager Open Metadata View Service (OMVS).
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCommentReply
(String serverName, String urlMarker, String elementGUID, String commentGUID, NewFeedbackRequestBody requestBody) Adds a reply to a comment.addCommentToElement
(String serverName, String urlMarker, String elementGUID, NewFeedbackRequestBody requestBody) Creates a comment and attaches it to an element.addLikeToElement
(String serverName, String urlMarker, String elementGUID, UpdateElementRequestBody requestBody) Creates a "like" object and attaches it to an element.addRatingToElement
(String serverName, String urlMarker, String elementGUID, UpdateElementRequestBody requestBody) Adds a star rating and optional review text to the element.addTagToElement
(String serverName, String urlMarker, String elementGUID, String tagGUID, MetadataSourceRequestBody requestBody) Adds an informal tag (either private of public) to an element.clearAcceptedAnswer
(String serverName, String urlMarker, String questionCommentGUID, String answerCommentGUID, DeleteRequestBody requestBody) Unlink a comment that contains an answer to a question posed in another comment.createInformalTag
(String serverName, String urlMarker, NewElementRequestBody requestBody) Creates a new informal tag and returns the unique identifier for it.createNoteLog
(String serverName, String urlMarker, String elementGUID, NewFeedbackRequestBody requestBody) Creates a new noteLog and returns the unique identifier for it.deleteTag
(String serverName, String urlMarker, String tagGUID, DeleteRequestBody requestBody) Removes an informal tag from the repository.findComments
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Return the list of comments containing the supplied string.findMyTags
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Return the list of the calling user's private tags containing the supplied string in either the name or description.findNoteLogs
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Retrieve the list of note log metadata elements that contain the search string.findTags
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Return the list of tags containing the supplied string in the text.getAttachedComments
(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody) Return the comments attached to an element.getAttachedLikes
(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody) Return the likes attached to an element.getAttachedRatings
(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody) Return the ratings attached to an element.getAttachedTags
(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody) Return the informal tags attached to an element.getComment
(String serverName, String urlMarker, String commentGUID, GetRequestBody requestBody) Return the requested comment.getElementsByTag
(String serverName, String urlMarker, String tagGUID, ResultsRequestBody requestBody) Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.getNoteLogByGUID
(String serverName, String urlMarker, String noteLogGUID, GetRequestBody requestBody) Retrieve the note log metadata element with the supplied unique identifier.getNoteLogsByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Retrieve the list of note log metadata elements with a matching qualified or display name.getNoteLogsForElement
(String serverName, String urlMarker, String elementGUID, ResultsRequestBody requestBody) Retrieve the list of note log metadata elements attached to the element.getNotesForNoteLog
(String serverName, String urlMarker, String noteLogGUID, ResultsRequestBody requestBody) Retrieve the list of notes associated with a note log.getTag
(String serverName, String urlMarker, String tagGUID, GetRequestBody requestBody) Return the informal tag for the supplied unique identifier (tagGUID).getTagsByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Return the tags exactly matching the supplied name.removeCommentFromElement
(String serverName, String urlMarker, String commentGUID, DeleteRequestBody requestBody) Removes a comment added to the element by this user.removeLikeFromElement
(String serverName, String urlMarker, String elementGUID, DeleteRequestBody requestBody) Removes a "Like" added to the element by this user.removeNoteLog
(String serverName, String urlMarker, String noteLogGUID, DeleteRequestBody requestBody) Removes a note log from the repository.removeRatingFromElement
(String serverName, String urlMarker, String elementGUID, DeleteRequestBody requestBody) Removes of a star rating/review that was added to the element by this user.removeTagFromElement
(String serverName, String urlMarker, String elementGUID, String tagGUID, DeleteRequestBody requestBody) Removes a link between a tag and an element that was added by this user.setupAcceptedAnswer
(String serverName, String urlMarker, String questionCommentGUID, String answerCommentGUID, NewRelationshipRequestBody requestBody) Link a comment that contains the best answer to a question posed in another comment.updateComment
(String serverName, String urlMarker, String commentGUID, UpdateElementRequestBody requestBody) Update an existing comment.updateNoteLog
(String serverName, String urlMarker, String noteLogGUID, UpdateElementRequestBody requestBody) Update an existing note log.updateTagDescription
(String serverName, String urlMarker, String tagGUID, UpdateElementRequestBody requestBody) Updates the description of an existing tag (either private or public).
-
Constructor Details
-
FeedbackManagerResource
public FeedbackManagerResource()Default constructor
-
-
Method Details
-
addCommentReply
@PostMapping(path="/elements/{elementGUID}/comments/{commentGUID}/replies") public GUIDResponse addCommentReply(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String commentGUID, @RequestBody(required=false) NewFeedbackRequestBody requestBody) Adds a reply to a comment.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- String - unique id for the anchor element.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:
- elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addCommentToElement
@PostMapping(path="/elements/{elementGUID}/comments") public GUIDResponse addCommentToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) NewFeedbackRequestBody requestBody) Creates a comment and attaches it to an element.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- String - unique id for the element.requestBody
- containing type of comment enum and the text of the comment.- Returns:
- elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addLikeToElement
@PostMapping(path="/elements/{elementGUID}/likes") public VoidResponse addLikeToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Creates a "like" object and attaches it to an element.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- String - unique id for the element.requestBody
- optional effective time- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addRatingToElement
@PostMapping(path="/elements/{elementGUID}/ratings") public VoidResponse addRatingToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Adds a star rating and optional review text to the element.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- String - unique id for the element.requestBody
- containing the StarRating and user review of element.- Returns:
- elementGUID for new review object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addTagToElement
@PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}") public VoidResponse addTagToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Adds an informal tag (either private of public) to an element.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- unique id for the element.tagGUID
- unique id of the tag.requestBody
- optional effective time- Returns:
- void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createInformalTag
@PostMapping(path="/tags") public GUIDResponse createInformalTag(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Creates a new informal tag and returns the unique identifier for it.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- public/private flag, name of the tag and (optional) description of the tag.- Returns:
- new elementGUID or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
deleteTag
@PostMapping(path="/tags/{tagGUID}/remove") public VoidResponse deleteTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes an informal tag from the repository. All the tagging relationships to this informal tag are lost. A private tag can be deleted by its creator and all the references are lost; a public tag can be deleted by anyone, but only if it is not attached to any referenceable.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markertagGUID
- 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 element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getElementsByTag
@PostMapping(path="/elements/by-tag/{tagGUID}/retrieve") public OpenMetadataRootElementsResponse getElementsByTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markertagGUID
- unique identifier of tag.requestBody
- optional effective time- Returns:
- element stubs list 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
@PostMapping(path="/tags/{tagGUID}/retrieve") public OpenMetadataRootElementResponse getTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the informal tag for the supplied unique identifier (tagGUID).- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markertagGUID
- unique identifier of the meaning.requestBody
- optional effective time- 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
@PostMapping(path="/tags/by-name") public OpenMetadataRootElementsResponse getTagsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Return the tags exactly matching the supplied name.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- name of tag.- 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.
-
findComments
@PostMapping(path="/comments/by-search-string") public OpenMetadataRootElementsResponse findComments(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Return the list of comments containing the supplied string.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- search string and effective time.- Returns:
- list of comment 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.
-
findTags
@PostMapping(path="/tags/by-search-string") public OpenMetadataRootElementsResponse findTags(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Return the list of tags containing the supplied string in the text. The search string is a regular expression (RegEx).- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- search string and effective time.- 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.
-
findMyTags
@PostMapping(path="/tags/private/by-search-string") public OpenMetadataRootElementsResponse findMyTags(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Return the list of the calling user's private tags containing the supplied string in either the name or description. The search string is a regular expression (RegEx).- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- search string and effective time.- 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.
-
removeCommentFromElement
@PostMapping(path="/comments/{commentGUID}/remove") public VoidResponse removeCommentFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes a comment added to the element by this user. This deletes the link to the comment, the comment itself and any comment replies attached to it.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markercommentGUID
- String - unique id for the comment objectrequestBody
- 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 element properties in the metadata repository. UserNotAuthorizedException the user does not have permission to perform this request.
-
getComment
@PostMapping(path="/comments/{commentGUID}/retrieve") public OpenMetadataRootElementResponse getComment(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the requested comment.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markercommentGUID
- unique identifier for the comment object.requestBody
- optional effective time- Returns:
- comment properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
getAttachedRatings
@PostMapping(path="/elements/{elementGUID}/ratings/retrieve") public OpenMetadataRootElementsResponse getAttachedRatings(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the ratings attached to an element.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- unique identifier for the element that the comments are connected to (maybe a comment too).requestBody
- optional effective time- Returns:
- list of ratings or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
getAttachedLikes
@PostMapping(path="/elements/{elementGUID}/likes/retrieve") public OpenMetadataRootElementsResponse getAttachedLikes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the likes attached to an element.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- unique identifier for the element that the comments are connected to (maybe a comment too).requestBody
- optional effective time- Returns:
- list of likes or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
getAttachedComments
@PostMapping(path="/elements/{elementGUID}/comments/retrieve") public OpenMetadataRootElementsResponse getAttachedComments(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the comments attached to an element.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- unique identifier for the element that the comments are connected to (maybe a comment too).requestBody
- optional effective time- Returns:
- list of comments or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
getAttachedTags
@PostMapping(path="/elements/{elementGUID}/tags/retrieve") public OpenMetadataRootElementsResponse getAttachedTags(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return the informal tags attached to an element.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- unique identifier for the element that the comments are connected to (maybe a comment too).requestBody
- optional effective time- Returns:
- list of informal tags or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
removeLikeFromElement
@PostMapping(path="/elements/{elementGUID}/likes/remove") public VoidResponse removeLikeFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes a "Like" added to the element by this user.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- unique identifier for the element where the like is attached.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 element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
removeRatingFromElement
@PostMapping(path="/elements/{elementGUID}/ratings/remove") public VoidResponse removeRatingFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes of a star rating/review that was added to the element by this user.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- unique identifier for the element where the rating is attached.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 element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
removeTagFromElement
@PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}/remove") public VoidResponse removeTagFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes a link between a tag and an element that was added by this user.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerelementGUID
- unique id for the element.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 element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
updateComment
@PostMapping(path="/comments/{commentGUID}/update") public VoidResponse updateComment(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update an existing comment.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markercommentGUID
- 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 element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
setupAcceptedAnswer
@PostMapping("/comments/questions/{questionCommentGUID}/answers/{answerCommentGUID}") public VoidResponse setupAcceptedAnswer(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Link a comment that contains the best answer to a question posed in another comment.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markerquestionCommentGUID
- unique identifier of the comment containing the questionanswerCommentGUID
- unique identifier of the comment containing the accepted answerrequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearAcceptedAnswer
@PostMapping("/comments/questions/{questionCommentGUID}/answers/{answerCommentGUID}/remove") public VoidResponse clearAcceptedAnswer(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Unlink a comment that contains an answer to a question posed in another comment.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markerquestionCommentGUID
- unique identifier of the comment containing the questionanswerCommentGUID
- unique identifier of the comment containing the accepted answerrequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateTagDescription
@PostMapping(path="/tags/{tagGUID}/update") public VoidResponse updateTagDescription(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestBody UpdateElementRequestBody requestBody) Updates the description of an existing tag (either private or public).- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markertagGUID
- unique id for the tagrequestBody
- 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.
-
createNoteLog
@PostMapping(path="/elements/{elementGUID}/note-logs") public GUIDResponse createNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody NewFeedbackRequestBody requestBody) Creates a new noteLog and returns the unique identifier for it.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- unique identifier of the element where the note log is locatedrequestBody
- contains the name of the tag and (optional) description of the tag- Returns:
- guid for new tag 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.
-
updateNoteLog
@PostMapping(path="/note-logs/{noteLogGUID}") public VoidResponse updateNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestBody UpdateElementRequestBody requestBody) Update an existing note log.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markernoteLogGUID
- unique identifier for the note log 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 element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
removeNoteLog
@PostMapping(path="/note-logs/{noteLogGUID}/remove") public VoidResponse removeNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Removes a note log from the repository. All the relationships to referenceables are lost.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markernoteLogGUID
- unique id for the note log.requestBody
- delete request body.- 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.
-
findNoteLogs
@PostMapping("/note-logs/by-search-string") public OpenMetadataRootElementsResponse findNoteLogs(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Retrieve the list of note log metadata elements that contain the search string.- Parameters:
serverName
- name of the server instances for this request.urlMarker
- view service URL markerrequestBody
- search string and effective time.- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogsByName
@PostMapping("/note-logs/by-name") public OpenMetadataRootElementsResponse getNoteLogsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Retrieve the list of note log metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerrequestBody
- name to search for and correlators- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogsForElement
@PostMapping("/elements/{elementGUID}/note-logs/retrieve") public OpenMetadataRootElementsResponse getNoteLogsForElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Retrieve the list of note log metadata elements attached to the element.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markerelementGUID
- element to start fromrequestBody
- optional effective time- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogByGUID
@PostMapping("/note-logs/{noteLogGUID}/retrieve") public OpenMetadataRootElementResponse getNoteLogByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestBody(required=false) GetRequestBody requestBody) Retrieve the note log metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markernoteLogGUID
- unique identifier of the requested metadata elementrequestBody
- optional effective time- Returns:
- requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNotesForNoteLog
@PostMapping("/note-logs/{noteLogGUID}/notes/retrieve") public OpenMetadataRootElementsResponse getNotesForNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Retrieve the list of notes associated with a note log.- Parameters:
serverName
- name of the server instances for this requesturlMarker
- view service URL markernoteLogGUID
- unique identifier of the note log of interestrequestBody
- optional effective time- Returns:
- list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-