Package org.odpi.openmetadata.viewservices.feedbackmanager.server

Class FeedbackManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.feedbackmanager.server.FeedbackManagerRESTServices
public class FeedbackManagerRESTServices extends TokenController
The FeedbackManagerRESTServices provides the implementation of the Feedback Manager Open Metadata View Service (OMVS). This interface provides view interfaces for glossary UIs.

  • Constructor Details

    • FeedbackManagerRESTServices

      public FeedbackManagerRESTServices()
      Default constructor

  • Method Details

    • addRatingToElement

      public VoidResponse addRatingToElement(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, RatingProperties requestBody)
      Adds a star rating and optional review text to the element. If the user has already attached a rating then the original one is over-ridden.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      requestBody - containing the StarRating and user review of referenceable (probably element).
      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.

    • removeRatingFromElement

      public VoidResponse removeRatingFromElement(String serverName, String guid, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a star rating that was added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the rating object
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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.

    • getAttachedRatings

      public RatingElementsResponse getAttachedRatings(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the comments attached to an element.
      Parameters:
      serverName - name of the server instances for this 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.
      viewServiceURLMarker - view service URL marker
      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.

    • addLikeToElement

      public VoidResponse addLikeToElement(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Adds a "LikeProperties" to the element.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      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.

    • removeLikeFromElement

      public VoidResponse removeLikeFromElement(String serverName, String guid, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a "LikeProperties" added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      guid - String - unique id for the like object
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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.

    • getAttachedLikes

      public LikeElementsResponse getAttachedLikes(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the likes attached to an element.
      Parameters:
      serverName - name of the server instances for this 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.
      viewServiceURLMarker - view service URL marker
      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.

    • addCommentToElement

      public GUIDResponse addCommentToElement(String serverName, String elementGUID, boolean isPublic, String viewServiceURLMarker, ReferenceableUpdateRequestBody requestBody)
      Adds a comment to the element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      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.

    • addCommentReply

      public GUIDResponse addCommentReply(String serverName, String elementGUID, String commentGUID, boolean isPublic, String viewServiceURLMarker, ReferenceableUpdateRequestBody requestBody)
      Adds a reply to a comment.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - String - unique id for the anchor element.
      commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      guid for new comment object or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateComment

      public VoidResponse updateComment(String serverName, String commentGUID, boolean isMergeUpdate, String viewServiceURLMarker, ReferenceableUpdateRequestBody requestBody)
      Update an existing comment.
      Parameters:
      serverName - name of the server instances for this 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)?
      viewServiceURLMarker - view service URL marker
      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.

    • updateCommentVisibility

      public VoidResponse updateCommentVisibility(String serverName, String parentGUID, String commentGUID, boolean isPublic, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Update an existing comment's visibility.
      Parameters:
      serverName - name of the server instances for this request.
      parentGUID - String - unique id for the attached element.
      commentGUID - unique identifier for the comment to change.
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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

      public VoidResponse setupAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, boolean isPublic, String viewServiceURLMarker, EffectiveTimeQueryRequestBody 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
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      isPublic - is this visible to other people
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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

      public VoidResponse clearAcceptedAnswer(String serverName, String questionCommentGUID, String answerCommentGUID, String viewServiceURLMarker, 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
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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)

    • removeCommentFromElement

      public VoidResponse removeCommentFromElement(String serverName, String commentGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a comment added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      commentGUID - String - unique id for the comment object
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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.

    • getCommentByGUID

      public CommentResponse getCommentByGUID(String serverName, String commentGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the requested comment.
      Parameters:
      serverName - name of the server instances for this request
      commentGUID - unique identifier for the comment object.
      viewServiceURLMarker - view service URL marker
      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.

    • getAttachedComments

      public CommentElementsResponse getAttachedComments(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the comments attached to an element.
      Parameters:
      serverName - name of the server instances for this 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.
      viewServiceURLMarker - view service URL marker
      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.

    • findComments

      public CommentElementsResponse findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, FilterRequestBody requestBody)
      Retrieve the list of comment metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      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)

    • createInformalTag

      public GUIDResponse createInformalTag(String serverName, String viewServiceURLMarker, TagProperties requestBody)
      Creates a new informal tag and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      viewServiceURLMarker - view service URL marker
      requestBody - 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.

    • updateTagDescription

      public VoidResponse updateTagDescription(String serverName, String tagGUID, String viewServiceURLMarker, InformalTagUpdateRequestBody requestBody)
      Updates the description of an existing tag (either private or public).
      Parameters:
      serverName - name of the server instances for this request
      tagGUID - unique id for the tag.
      viewServiceURLMarker - view service URL marker
      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.

    • deleteTag

      public VoidResponse deleteTag(String serverName, String tagGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a tag from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      tagGUID - unique id for the tag.
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time.
      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.

    • getTag

      public InformalTagResponse getTag(String serverName, String guid, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the tag for the supplied unique identifier (guid).
      Parameters:
      serverName - name of the server instances for this request
      guid - unique identifier of the tag.
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      Tag object 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.

    • getTagsByName

      public InformalTagsResponse getTagsByName(String serverName, int startFrom, int pageSize, String viewServiceURLMarker, FilterRequestBody requestBody)
      Return the list of tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - view service URL marker
      requestBody - name of tag.
      Returns:
      tag list 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

      public InformalTagsResponse findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, FilterRequestBody requestBody)
      Return the list of tags containing the supplied string in either the name or description.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      tag list 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

      public InformalTagsResponse findMyTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, FilterRequestBody requestBody)
      Return the list of the calling user's private tags containing the supplied string in either the name or description.
      Parameters:
      serverName - name of the server to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      tag list 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.

    • addTagToElement

      public VoidResponse addTagToElement(String serverName, String elementGUID, String tagGUID, boolean isPublic, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Adds a tag (either private of public) to an element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique id for the element.
      tagGUID - unique id of the tag.
      isPublic - visibility of link
      viewServiceURLMarker - view service URL marker
      requestBody - feedback 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.

    • removeTagFromElement

      public VoidResponse removeTagFromElement(String serverName, String elementGUID, String tagGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a tag from the element that was added by this user.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique id for the element.
      tagGUID - unique id for the tag.
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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.

    • getElementsByTag

      public RelatedElementsResponse getElementsByTag(String serverName, String tagGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody 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 request
      tagGUID - unique identifier of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - view service URL marker
      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.

    • getAttachedTags

      public InformalTagsResponse getAttachedTags(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Return the informal tags attached to an element.
      Parameters:
      serverName - name of the server instances for this 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.
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      Returns:
      list of 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.

    • createNoteLog

      public GUIDResponse createNoteLog(String serverName, String elementGUID, boolean isPublic, String viewServiceURLMarker, NoteLogProperties requestBody)
      Creates a new noteLog and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the element where the note log is located
      isPublic - is this element visible to other people.
      viewServiceURLMarker - view service URL marker
      requestBody - 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

      public VoidResponse updateNoteLog(String serverName, String noteLogGUID, boolean isMergeUpdate, String viewServiceURLMarker, ReferenceableUpdateRequestBody requestBody)
      Update an existing note log.
      Parameters:
      serverName - name of the server instances for this request.
      noteLogGUID - unique identifier for the note log to change.
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      viewServiceURLMarker - view service URL marker
      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.

    • deleteNoteLog

      public VoidResponse deleteNoteLog(String serverName, String noteLogGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a note log from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique id for the note log.
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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

      public NoteLogsResponse findNoteLogs(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, FilterRequestBody 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 to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      viewServiceURLMarker - view service URL marker
      requestBody - string to find in the properties
      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

      public NoteLogsResponse getNoteLogsByName(String serverName, int startFrom, int pageSize, String viewServiceURLMarker, 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 request
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - view service URL marker
      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

      public NoteLogsResponse getNoteLogsForElement(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of note log metadata elements attached to the element.
      Parameters:
      serverName - name of the server instances for this request
      elementGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - view service URL marker
      requestBody - 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)

    • getNoteLogByGUID

      public NoteLogResponse getNoteLogByGUID(String serverName, String noteLogGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note log metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique identifier of the requested metadata element
      viewServiceURLMarker - view service URL marker
      requestBody - 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)

    • createNote

      public GUIDResponse createNote(String serverName, String noteLogGUID, String viewServiceURLMarker, NoteProperties requestBody)
      Creates a new note for a note log and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique identifier of the note log
      viewServiceURLMarker - view service URL marker
      requestBody - 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.

    • updateNote

      public VoidResponse updateNote(String serverName, String noteGUID, boolean isMergeUpdate, String viewServiceURLMarker, ReferenceableUpdateRequestBody requestBody)
      Update an existing note.
      Parameters:
      serverName - name of the server instances for this request.
      noteGUID - unique identifier for the note to change.
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      viewServiceURLMarker - view service URL marker
      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.

    • deleteNote

      public VoidResponse deleteNote(String serverName, String noteGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Removes a note from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      noteGUID - unique id for the note .
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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.

    • findNotes

      public NotesResponse findNotes(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, FilterRequestBody 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 to route the request to
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - view service URL marker
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      requestBody - string to find in the properties
      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

      public NotesResponse getNotesForNoteLog(String serverName, String noteLogGUID, int startFrom, int pageSize, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of notes associated with a note log.
      Parameters:
      serverName - name of the server instances for this request
      noteLogGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - view service URL marker
      requestBody - 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)

    • getNoteByGUID

      public NoteResponse getNoteByGUID(String serverName, String noteGUID, String viewServiceURLMarker, EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      noteGUID - unique identifier of the requested metadata element
      viewServiceURLMarker - view service URL marker
      requestBody - optional effective time
      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)