Package org.odpi.openmetadata.accessservices.assetmanager.server.spring

Class CollaborationExchangeResource

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.spring.CollaborationExchangeResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}") public class CollaborationExchangeResource extends Object
The CollaborationExchangeResource provides part of the server-side implementation of the Asset Manager Open Metadata Assess Service (OMAS). This interface provides collaboration elements support - such as comments, likes, ratings, informal tags.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CollaborationExchangeResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addCommentReply(String serverName, String userId, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Adds a reply to a comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addCommentToElement(String serverName, String userId, String elementGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Creates a comment and attaches it to an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addLikeToElement(String serverName, String userId, String elementGUID, boolean isPublic, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Creates a "like" object and attaches it to an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addRatingToElement(String serverName, String userId, String elementGUID, boolean isPublic, org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.RatingProperties requestBody)
    Adds a star rating and optional review text to the element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addTagToElement(String serverName, String userId, String elementGUID, String tagGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.FeedbackProperties requestBody)
    Adds an informal tag (either private of public) to an element.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    clearAcceptedAnswer(String serverName, String userId, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Unlink a comment that contains an answer to a question posed in another comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createInformalTag(String serverName, String userId, org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.TagProperties requestBody)
    Creates a new informal tag and returns the unique identifier for it.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createNote(String serverName, String userId, String noteLogGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Create a new metadata element to represent a note.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    createNoteLog(String serverName, String userId, String elementGUID, boolean assetManagerIsHome, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Create a new metadata element to represent a note log and attach it to an element (if supplied).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteTag(String serverName, String userId, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes an informal tag from the repository.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    findMyTags(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Return the list of the calling user's private tags containing the supplied string in either the name or description.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    findNoteLogs(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Retrieve the list of note log metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse
    findNotes(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Retrieve the list of note metadata elements that contain the search string.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    findTags(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
    Return the list of informal tags containing the supplied string in either the name or description.
    org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse
    getAttachedComments(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Return the comments attached to an element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementResponse
    getComment(String serverName, String userId, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Return the requested comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse
    getElementsByTag(String serverName, String userId, String tagGUID, int startFrom, int pageSize)
    Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    getMyTagsByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Return the list of the calling user's private informal tags exactly matching the supplied name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementResponse
    getNoteByGUID(String serverName, String userId, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the note metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementResponse
    getNoteLogByGUID(String serverName, String userId, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the note log metadata element with the supplied unique identifier.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    getNoteLogsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Retrieve the list of note log metadata elements with a matching qualified or display name.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse
    getNoteLogsForElement(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of note log metadata elements attached to the element.
    org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse
    getNotesForNoteLog(String serverName, String userId, String noteLogGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
    Retrieve the list of notes associated with a note log.
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagResponse
    getTag(String serverName, String userId, String tagGUID)
    Return the informal tag for the supplied unique identifier (tagGUID).
    org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse
    getTagsByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
    Return the tags exactly matching the supplied name.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeCommentFromElement(String serverName, String userId, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Removes a comment added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeLikeFromElement(String serverName, String userId, String elementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a "Like" added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeNote(String serverName, String userId, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Remove the metadata element representing a note.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeNoteLog(String serverName, String userId, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Remove the metadata element representing a note log.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeRatingFromElement(String serverName, String userId, String elementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes of a star rating/review that was added to the element by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeTagFromElement(String serverName, String userId, String elementGUID, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Removes a link between a tag and an element that was added by this user.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    setupAcceptedAnswer(String serverName, String userId, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody requestBody)
    Link a comment that contains the best answer to a question posed in another comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateComment(String serverName, String userId, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Update an existing comment.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateNote(String serverName, String userId, String noteGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Update the properties of the metadata element representing a note.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateNoteLog(String serverName, String userId, String noteLogGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
    Update the metadata element representing a note log.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateTagDescription(String serverName, String userId, String tagGUID, org.odpi.openmetadata.commonservices.ffdc.rest.InformalTagUpdateRequestBody requestBody)
    Updates the description of an existing tag (either private or public).

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CollaborationExchangeResource

      public CollaborationExchangeResource()
      Default constructor

  • Method Details

    • addCommentReply

      @PostMapping(path="/comments/{commentGUID}/replies") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addCommentReply(@PathVariable String serverName, @PathVariable String userId, @PathVariable String commentGUID, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody 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.
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addCommentToElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Creates a comment and attaches it to an element.
      Parameters:
      serverName - name of the server instances for this request.
      userId - String - userId of user making request.
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addLikeToElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Creates a "like" object and attaches it to an element.
      Parameters:
      serverName - name of the server instances for this request.
      userId - String - userId of user making request.
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      requestBody - feedback request body.
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addRatingToElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestBody org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.RatingProperties requestBody)
      Adds a star rating and optional review text to the element.
      Parameters:
      serverName - name of the server instances for this request.
      userId - String - userId of user making request.
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addTagToElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.FeedbackProperties requestBody)
      Adds an informal tag (either private of public) to an element.
      Parameters:
      serverName - name of the server instances for this request.
      userId - userId of user making request.
      elementGUID - 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 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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createInformalTag(@PathVariable String serverName, @PathVariable String userId, @RequestBody org.odpi.openmetadata.frameworks.openmetadata.properties.feedback.TagProperties requestBody)
      Creates a new 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 - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteTag(@PathVariable String serverName, @PathVariable String userId, @PathVariable String tagGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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 request
      userId - String - userId of user making request.
      tagGUID - 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

      @GetMapping(path="/elements/by-tag/{tagGUID}") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDListResponse getElementsByTag(@PathVariable String serverName, @PathVariable String userId, @PathVariable String tagGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      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 request
      userId - the name of the calling user.
      tagGUID - unique identifier of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      Returns:
      element guid 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

      @GetMapping(path="/tags/{tagGUID}") public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagResponse getTag(@PathVariable String serverName, @PathVariable String userId, @PathVariable String tagGUID)
      Return the informal tag for the supplied unique identifier (tagGUID).
      Parameters:
      serverName - name of the server instances for this request.
      userId - userId of the user making the request.
      tagGUID - 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

      @PostMapping(path="/tags/by-name") public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse getTagsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
      Return the tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request.
      userId - the name of the calling user.
      requestBody - name of tag.
      startFrom - index of the list to 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.

    • getMyTagsByName

      @PostMapping(path="/tags/private/by-name") public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse getMyTagsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody requestBody)
      Return the list of the calling user's private informal tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request.
      userId - the name of the calling user.
      requestBody - name of tag.
      startFrom - index of the list to 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.

    • findTags

      @PostMapping(path="/tags/by-search-string") public org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse findTags(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
      Return the list of informal 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.
      userId - the name of the calling user.
      requestBody - 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.
      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 org.odpi.openmetadata.accessservices.assetmanager.rest.InformalTagsResponse findMyTags(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.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.
      userId - the name of the calling user.
      requestBody - 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.
      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="/elements/{elementGUID}/comments/{commentGUID}/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeCommentFromElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody 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 request
      userId - String - userId of user making request.
      elementGUID - String - unique id for the element object
      commentGUID - String - unique id for the comment object
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 user does not have permission to perform this request.

    • getComment

      @PostMapping(path="/comments/{commentGUID}") public org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementResponse getComment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Return the requested comment.
      Parameters:
      serverName - name of the server instances for this request
      userId - userId of user making request.
      commentGUID - unique identifier for the comment object.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties controlling the request
      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.

    • getAttachedComments

      @PostMapping(path="/elements/{elementGUID}/comments/retrieve") public org.odpi.openmetadata.accessservices.assetmanager.rest.CommentElementsResponse getAttachedComments(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Return the comments attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      userId - userId of user making request.
      elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties controlling the request
      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.

    • removeLikeFromElement

      @PostMapping(path="/elements/{elementGUID}/likes/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeLikeFromElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
      Removes a "Like" added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request.
      userId - String - userId of user making request.
      elementGUID - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeRatingFromElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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.
      userId - String - userId of user making request.
      elementGUID - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeTagFromElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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.
      userId - String - userId of user making request.
      elementGUID - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateComment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean isMergeUpdate, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody 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.
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      isPublic - is this visible to other people
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse setupAcceptedAnswer(@PathVariable String serverName, @PathVariable String userId, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.RelationshipRequestBody 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 to
      userId - calling user
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse clearAcceptedAnswer(@PathVariable String serverName, @PathVariable String userId, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody 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 to
      userId - calling user
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateTagDescription(@PathVariable String serverName, @PathVariable String userId, @PathVariable String tagGUID, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.InformalTagUpdateRequestBody requestBody)
      Updates the description of an existing tag (either private or 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.

    • createNoteLog

      @PostMapping("/elements/{elementGUID}/note-logs") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createNoteLog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean assetManagerIsHome, @RequestParam(required=false,defaultValue="true") boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Create a new metadata element to represent a note log and attach it to an element (if supplied). Any supplied element becomes the note log's anchor, causing the note log to be deleted if/when the element is deleted.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this element
      elementGUID - unique identifier of the element where the note log is located
      isPublic - is this element visible to other people.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to control the type of the request
      Returns:
      unique identifier of the new note log 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)

    • updateNoteLog

      @PostMapping("/note-logs/{noteLogGUID}/update") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateNoteLog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteLogGUID, @RequestParam(required=false,defaultValue="false") boolean isMergeUpdate, @RequestParam(required=false,defaultValue="true") boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Update the metadata element representing a note log.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteLogGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      isPublic - is this element visible to other people.
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for the metadata element
      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)

    • removeNoteLog

      @PostMapping("/note-logs/{noteLogGUID}/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeNoteLog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteLogGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Remove the metadata element representing a note log.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteLogGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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)

    • findNoteLogs

      @PostMapping("/note-logs/by-search-string") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse findNoteLogs(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
      Retrieve the list of note log metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - string to find in the properties 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)

    • getNoteLogsByName

      @PostMapping("/note-logs/by-name") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse getNoteLogsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.NameRequestBody 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 request
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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 org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementsResponse getNoteLogsForElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of note log metadata elements attached to the element.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      elementGUID - element to start from
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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)

    • getNoteLogByGUID

      @PostMapping("/note-logs/{noteLogGUID}/retrieve") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteLogElementResponse getNoteLogByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteLogGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note log metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteLogGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      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)

    • createNote

      @PostMapping("/note-logs/{noteLogGUID}/notes") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse createNote(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteLogGUID, @RequestParam(required=false,defaultValue="false") boolean assetManagerIsHome, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Create a new metadata element to represent a note.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      assetManagerIsHome - ensure that only the asset manager can update this element
      noteLogGUID - unique identifier of the element where the note is located
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      unique identifier of the new metadata element for the note 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)

    • updateNote

      @PostMapping("/note-logs/notes/{noteGUID}/update") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateNote(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteGUID, @RequestParam(required=false,defaultValue="false") boolean isMergeUpdate, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Update the properties of the metadata element representing a note.
      Parameters:
      userId - calling user
      serverName - name of the server instances for this request
      noteGUID - unique identifier of the note to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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)

    • removeNote

      @PostMapping("/note-logs/notes/{noteGUID}/remove") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeNote(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.ReferenceableUpdateRequestBody requestBody)
      Remove the metadata element representing a note.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - 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)

    • findNotes

      @PostMapping("/note-logs/notes/by-search-string") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse findNotes(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody org.odpi.openmetadata.accessservices.assetmanager.rest.SearchStringRequestBody requestBody)
      Retrieve the list of note metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - string to find in the properties 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)

    • getNotesForNoteLog

      @PostMapping("/note-logs/{noteLogGUID}/notes/retrieve") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementsResponse getNotesForNoteLog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteLogGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of notes associated with a note log.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteLogGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      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)

    • getNoteByGUID

      @PostMapping("/note-logs/notes/{noteGUID}/retrieve") public org.odpi.openmetadata.accessservices.assetmanager.rest.NoteElementResponse getNoteByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String noteGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetmanager.rest.EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      noteGUID - unique identifier of the requested metadata element
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      Returns:
      matching 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)