Class CollaborationExchangeRESTServices

java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.CollaborationExchangeRESTServices

public class CollaborationExchangeRESTServices extends Object
The AssetManagerRESTServices provides the server-side implementation of the Asset Manager Open Metadata Assess Service (OMAS). This interface provides connections to elements and APIs for adding feedback on the element.
  • Constructor Details

    • CollaborationExchangeRESTServices

      public CollaborationExchangeRESTServices()
      Default constructor
  • Method Details

    • addRatingToElement

      public VoidResponse addRatingToElement(String serverName, String userId, String guid, boolean isPublic, 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
      userId - String - userId of user making request.
      guid - String - unique id for the element.
      isPublic - is this visible to other people
      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 userId, String guid, NullRequestBody requestBody)
      Removes a star rating 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.
      guid - String - unique id for the rating object
      requestBody - null request body needed to satisfy the HTTP Post request
      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.
    • addLikeToElement

      public VoidResponse addLikeToElement(String serverName, String userId, String guid, boolean isPublic, NullRequestBody requestBody)
      Adds a "LikeProperties" to the element.
      Parameters:
      serverName - name of the server instances for this request
      userId - String - userId of user making request.
      guid - 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.
    • removeLikeFromElement

      public VoidResponse removeLikeFromElement(String serverName, String userId, String guid, NullRequestBody requestBody)
      Removes a "LikeProperties" added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request
      userId - String - userId of user making request.
      guid - String - unique id for the like object
      requestBody - null request body needed to satisfy the HTTP Post request
      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.
    • addCommentToElement

      public GUIDResponse addCommentToElement(String serverName, String userId, String guid, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Adds a comment to the element.
      Parameters:
      serverName - name of the server instances for this request
      userId - String - userId of user making request.
      guid - 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:
      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.
    • addCommentReply

      public GUIDResponse addCommentReply(String serverName, String userId, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, 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:
      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 userId, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse setupAcceptedAnswer(String serverName, String userId, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse clearAcceptedAnswer(String serverName, String userId, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, 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)
    • removeCommentFromElement

      public VoidResponse removeCommentFromElement(String serverName, String userId, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Removes a comment 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 - 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 - null request body needed to satisfy the HTTP Post request
      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 CommentElementResponse getCommentByGUID(String serverName, String userId, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, 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 - effectiveTime and asset manager identifiers
      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 userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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 - effectiveTime and asset manager identifiers
      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.
    • createInformalTag

      public GUIDResponse createInformalTag(String serverName, String userId, 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 - 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 userId, String tagGUID, 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.
    • deleteTag

      public VoidResponse deleteTag(String serverName, String userId, String tagGUID, NullRequestBody requestBody)
      Removes a tag from the repository. All the relationships to referenceables are lost.
      Parameters:
      serverName - name of the server instances for this request
      userId - userId of user making request.
      tagGUID - unique id for the tag.
      requestBody - null 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.
    • getTag

      public InformalTagResponse getTag(String serverName, String userId, String guid)
      Return the tag for the supplied unique identifier (guid).
      Parameters:
      serverName - name of the server instances for this request
      userId - userId of the user making the request.
      guid - unique identifier of the tag.
      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, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Return the list of 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:
      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.
    • getMyTagsByName

      public InformalTagsResponse getMyTagsByName(String serverName, String userId, NameRequestBody requestBody, int startFrom, int pageSize)
      Return the list of the calling user's private 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:
      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, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      Return the list of tags containing the supplied string in either the name or description.
      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:
      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, String userId, SearchStringRequestBody requestBody, int startFrom, int pageSize)
      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 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:
      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 userId, String elementGUID, String tagGUID, FeedbackProperties requestBody)
      Adds a 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 - 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 userId, String elementGUID, String tagGUID, NullRequestBody requestBody)
      Removes a tag from the element that was added by this user.
      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 for the tag.
      requestBody - null request body needed for correct protocol exchange.
      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 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.
      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.
    • createNoteLog

      public GUIDResponse createNoteLog(String serverName, String userId, String elementGUID, boolean assetManagerIsHome, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse updateNoteLog(String serverName, String userId, String noteLogGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse removeNoteLog(String serverName, String userId, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteLogElementsResponse findNoteLogs(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteLogElementsResponse getNoteLogsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteLogElementsResponse getNoteLogsForElement(String serverName, String userId, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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 - 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)
    • getNoteLogByGUID

      public NoteLogElementResponse getNoteLogByGUID(String serverName, String userId, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, 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 - correlators
      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 userId, boolean assetManagerIsHome, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse updateNote(String serverName, String userId, String noteGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, 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

      public VoidResponse removeNote(String serverName, String userId, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteElementsResponse findNotes(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteElementsResponse getNotesForNoteLog(String serverName, String userId, String noteLogGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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

      public NoteElementResponse getNoteByGUID(String serverName, String userId, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, 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)