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

Class FeedbackManagerResource

java.lang.Object
org.odpi.openmetadata.viewservices.feedbackmanager.server.spring.FeedbackManagerResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}") public class FeedbackManagerResource extends Object
The FeedbackManagerResource provides the Spring API endpoints of the Feedback Manager Open Metadata View Service (OMVS). =

  • Constructor Details

    • FeedbackManagerResource

      public FeedbackManagerResource()
      Default constructor

  • Method Details

    • addCommentReply

      @PostMapping(path="/elements/{elementGUID}/comments/{commentGUID}/replies") public GUIDResponse addCommentReply(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody ReferenceableUpdateRequestBody requestBody)
      Adds a reply to a comment.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addCommentToElement

      @PostMapping(path="/elements/{elementGUID}/comments") public GUIDResponse addCommentToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody ReferenceableUpdateRequestBody requestBody)
      Creates a comment and attaches it to an element.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addLikeToElement

      @PostMapping(path="/elements/{elementGUID}/likes") public VoidResponse addLikeToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Creates a "like" object and attaches it to an element.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addRatingToElement

      @PostMapping(path="/elements/{elementGUID}/ratings") public VoidResponse addRatingToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody RatingProperties requestBody)
      Adds a star rating and optional review text to the element.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - String - unique id for the element.
      isPublic - is this visible to other people
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing the StarRating and user review of element.
      Returns:
      elementGUID for new review object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • addTagToElement

      @PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}") public VoidResponse addTagToElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Adds an informal tag (either private of public) to an element.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - unique id for the element.
      tagGUID - unique id of the tag.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createInformalTag

      @PostMapping(path="/tags") public GUIDResponse createInformalTag(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody TagProperties requestBody)
      Creates a new informal tag and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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 VoidResponse deleteTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody 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
      urlMarker - view service URL marker
      tagGUID - String - unique id for the tag.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - null request body.
      Returns:
      void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getElementsByTag

      @PostMapping(path="/elements/by-tag/{tagGUID}/retrieve") public RelatedElementsResponse getElementsByTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) 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
      urlMarker - view service URL marker
      tagGUID - unique identifier of tag.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      element stubs list or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getTag

      @PostMapping(path="/tags/{tagGUID}/retrieve") public InformalTagResponse getTag(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the informal tag for the supplied unique identifier (tagGUID).
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      tagGUID - unique identifier of the meaning.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      tag object or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getTagsByName

      @PostMapping(path="/tags/by-name") public InformalTagsResponse getTagsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody FilterRequestBody requestBody)
      Return the tags exactly matching the supplied name.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      requestBody - name of tag.
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      Returns:
      list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findComments

      @PostMapping(path="/comments/by-search-string") public CommentElementsResponse findComments(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return the list of comments containing the supplied string.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - 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?
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - search string and effective time.
      Returns:
      list of comment objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findTags

      @PostMapping(path="/tags/by-search-string") public InformalTagsResponse findTags(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return the list of tags containing the supplied string in the text. The search string is a regular expression (RegEx).
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL 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?
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - search string and effective time.
      Returns:
      list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findMyTags

      @PostMapping(path="/tags/private/by-search-string") public InformalTagsResponse findMyTags(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Return the list of the calling user's private tags containing the supplied string in either the name or description. The search string is a regular expression (RegEx).
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL 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?
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - search string and effective time.
      Returns:
      list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeCommentFromElement

      @PostMapping(path="/comments/{commentGUID}/remove") public VoidResponse removeCommentFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody 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
      urlMarker - view service URL marker
      commentGUID - String - unique id for the comment object
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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}/retrieve") public CommentResponse getComment(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the requested comment.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      commentGUID - unique identifier for the comment object.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      comment properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getAttachedRatings

      @PostMapping(path="/elements/{elementGUID}/ratings/retrieve") public RatingElementsResponse getAttachedRatings(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the ratings attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      list of ratings or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getAttachedLikes

      @PostMapping(path="/elements/{elementGUID}/likes/retrieve") public LikeElementsResponse getAttachedLikes(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the likes attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      list of likes or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getAttachedComments

      @PostMapping(path="/elements/{elementGUID}/comments/retrieve") public CommentElementsResponse getAttachedComments(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the comments attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      list of comments or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • getAttachedTags

      @PostMapping(path="/elements/{elementGUID}/tags/retrieve") public InformalTagsResponse getAttachedTags(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the informal tags attached to an element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      list of informal tags or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.

    • removeLikeFromElement

      @PostMapping(path="/elements/{elementGUID}/likes/remove") public VoidResponse removeLikeFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Removes a "Like" added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - unique identifier for the element where the like is attached.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeRatingFromElement

      @PostMapping(path="/elements/{elementGUID}/ratings/remove") public VoidResponse removeRatingFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Removes of a star rating/review that was added to the element by this user.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - unique identifier for the element where the rating is attached.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeTagFromElement

      @PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}/remove") public VoidResponse removeTagFromElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Removes a link between a tag and an element that was added by this user.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      elementGUID - unique id for the element.
      tagGUID - unique id of the tag.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - null request body needed for correct protocol exchange.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateComment

      @PostMapping(path="/comments/{commentGUID}/update") public VoidResponse updateComment(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean isMergeUpdate, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody ReferenceableUpdateRequestBody requestBody)
      Update an existing comment.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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

      @PostMapping(path="/parents/{parentGUID}/comments/{commentGUID}/update-visibility") public VoidResponse updateCommentVisibility(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentGUID, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Update an existing comment's visibility.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      commentGUID - unique identifier for the comment to change.
      isPublic - is this visible to other people
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • setupAcceptedAnswer

      @PostMapping("/comments/questions/{questionCommentGUID}/answers/{answerCommentGUID}") public VoidResponse setupAcceptedAnswer(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) 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
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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 VoidResponse clearAcceptedAnswer(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) 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
      urlMarker - view service URL marker
      questionCommentGUID - unique identifier of the comment containing the question
      answerCommentGUID - unique identifier of the comment containing the accepted answer
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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 VoidResponse updateTagDescription(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String tagGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody InformalTagUpdateRequestBody requestBody)
      Updates the description of an existing tag (either private or public).
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      tagGUID - unique id for the tag
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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(path="/elements/{elementGUID}/note-logs") public GUIDResponse createNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="false") boolean isPublic, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody NoteLogProperties requestBody)
      Creates a new noteLog and returns the unique identifier for it.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - unique identifier of the element where the note log is located
      isPublic - is this element visible to other people.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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

      @PostMapping(path="/note-logs/{noteLogGUID}") public VoidResponse updateNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestParam boolean isMergeUpdate, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody ReferenceableUpdateRequestBody requestBody)
      Update an existing note log.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - containing type of comment enum and the text of the comment.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • removeNoteLog

      @PostMapping(path="/note-logs/{noteLogGUID}/remove") public VoidResponse removeNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) 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
      urlMarker - view service URL marker
      noteLogGUID - unique id for the note log.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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.

    • findNoteLogs

      @PostMapping("/note-logs/by-search-string") public NoteLogsResponse findNoteLogs(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the list of note log metadata elements that contain the search string.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL 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?
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - search string and effective time.
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getNoteLogsByName

      @PostMapping("/note-logs/by-name") public NoteLogsResponse getNoteLogsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody 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
      urlMarker - view service URL marker
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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 NoteLogsResponse getNoteLogsForElement(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of note log metadata elements attached to the element.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      elementGUID - element to start from
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - optional effective time
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getNoteLogByGUID

      @PostMapping("/note-logs/{noteLogGUID}/retrieve") public NoteLogResponse getNoteLogByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note log metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      noteLogGUID - unique identifier of the requested metadata element
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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

      @PostMapping(path="/note-logs/{noteLogGUID}/notes") public GUIDResponse createNote(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody 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
      urlMarker - view service URL marker
      noteLogGUID - unique identifier of the note log
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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

      @PostMapping(path="/notes/{noteGUID}") public VoidResponse updateNote(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteGUID, @RequestParam boolean isMergeUpdate, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody ReferenceableUpdateRequestBody requestBody)
      Update an existing note.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - view service URL marker
      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 - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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.

    • removeNote

      @PostMapping(path="/notes/{noteGUID}/remove") public VoidResponse removeNote(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) 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
      urlMarker - view service URL marker
      noteGUID - unique id for the note .
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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.

    • findNotes

      @PostMapping("/note-logs/notes/by-search-string") public NotesResponse findNotes(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the list of note metadata elements that contain the search string.
      Parameters:
      serverName - name of the server instances for this request.
      urlMarker - 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?
      startFrom - index of the list to start from (0 for start).
      pageSize - maximum number of elements to return.
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      requestBody - search string and effective time.
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getNotesForNoteLog

      @PostMapping("/note-logs/{noteLogGUID}/notes/retrieve") public NotesResponse getNotesForNoteLog(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteLogGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of notes associated with a note log.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      noteLogGUID - unique identifier of the note log of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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

      @PostMapping("/note-logs/notes/{noteGUID}/retrieve") public NoteResponse getNoteByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String noteGUID, @RequestParam(required=false) String viewServiceURLMarker, @RequestParam(required=false,defaultValue="asset-manager") String accessServiceURLMarker, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the note metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server instances for this request
      urlMarker - view service URL marker
      noteGUID - unique identifier of the requested metadata element
      viewServiceURLMarker - optional view service URL marker (overrides accessServiceURLMarker)
      accessServiceURLMarker - optional access service URL marker used to identify which back end service to call
      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)