Class FeedbackManagerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.feedbackmanager.server.FeedbackManagerRESTServices
The FeedbackManagerRESTServices provides the implementation of the Feedback Manager Open Metadata View Service (OMVS).
This interface provides view interfaces for glossary UIs.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddCommentReply
(String serverName, String commentGUID, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a reply to a comment.addCommentToElement
(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a comment to the element.addLikeToElement
(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Adds a "LikeProperties" to the element.addRatingToElement
(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, RatingProperties requestBody) Adds a star rating and optional review text to the element.addTagToElement
(String serverName, String elementGUID, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, FeedbackProperties requestBody) Adds a tag (either private of public) to an element.clearAcceptedAnswer
(String serverName, String questionCommentGUID, String answerCommentGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Unlink a comment that contains an answer to a question posed in another comment.createInformalTag
(String serverName, String viewServiceURLMarker, String accessServiceURLMarker, TagProperties requestBody) Creates a new informal tag and returns the unique identifier for it.deleteTag
(String serverName, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a tag from the repository.findComments
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of comment metadata elements that contain the search string.findMyTags
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, SearchStringRequestBody requestBody) Return the list of the calling user's private tags containing the supplied string in either the name or description.findNoteLogs
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of note log metadata elements that contain the search string.findNotes
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of note metadata elements that contain the search string.findTags
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, SearchStringRequestBody requestBody) Return the list of tags containing the supplied string in either the name or description.getAttachedComments
(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the comments attached to an element.getCommentByGUID
(String serverName, String commentGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the requested comment.getElementsByTag
(String serverName, String tagGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.getMyTagsByName
(String serverName, NameRequestBody requestBody, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) Return the list of the calling user's private tags exactly matching the supplied name.getNoteByGUID
(String serverName, String noteGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note metadata element with the supplied unique identifier.getNoteLogByGUID
(String serverName, String noteLogGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note log metadata element with the supplied unique identifier.getNoteLogsByName
(String serverName, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of note log metadata elements with a matching qualified or display name.getNoteLogsForElement
(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of note log metadata elements attached to the element.getNotesForNoteLog
(String serverName, String noteLogGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of notes associated with a note log.Return the tag for the supplied unique identifier (guid).getTagsByName
(String serverName, NameRequestBody requestBody, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) Return the list of tags exactly matching the supplied name.removeCommentFromElement
(String serverName, String elementGUID, String commentGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Removes a comment added to the element by this user.removeLikeFromElement
(String serverName, String guid, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a "LikeProperties" added to the element by this user.removeRatingFromElement
(String serverName, String guid, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a star rating that was added to the element by this user.removeTagFromElement
(String serverName, String elementGUID, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a tag from the element that was added by this user.setupAcceptedAnswer
(String serverName, String questionCommentGUID, String answerCommentGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link a comment that contains the best answer to a question posed in another comment.updateComment
(String serverName, String commentGUID, boolean isMergeUpdate, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update an existing comment.updateTagDescription
(String serverName, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, InformalTagUpdateRequestBody requestBody) Updates the description of an existing tag (either private or public).Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
FeedbackManagerRESTServices
public FeedbackManagerRESTServices()Default constructor
-
-
Method Details
-
addRatingToElement
public VoidResponse addRatingToElement(String serverName, String guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestguid
- String - unique id for the element.isPublic
- is this visible to other peopleviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- containing the StarRating and user review of referenceable (probably element).- Returns:
- void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem adding the element properties to the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
removeRatingFromElement
public VoidResponse removeRatingFromElement(String serverName, String guid, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a star rating that was added to the element by this user.- Parameters:
serverName
- name of the server instances for this requestguid
- String - unique id for the rating objectviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- 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 guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Adds a "LikeProperties" to the element.- Parameters:
serverName
- name of the server instances for this requestguid
- String - unique id for the element.isPublic
- is this visible to other peopleviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- 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 guid, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a "LikeProperties" added to the element by this user.- Parameters:
serverName
- name of the server instances for this requestguid
- String - unique id for the like objectviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- 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 guid, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a comment to the element.- Parameters:
serverName
- name of the server instances for this requestguid
- String - unique id for the element.isPublic
- is this visible to other peopleviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 commentGUID, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a reply to a comment.- Parameters:
serverName
- name of the server instances for this requestcommentGUID
- String - unique id for an existing comment. Used to add a reply to a comment.isPublic
- is this visible to other peopleviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 commentGUID, boolean isMergeUpdate, boolean isPublic, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update an existing comment.- Parameters:
serverName
- name of the server instances for this request.commentGUID
- unique identifier for the comment to change.isMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?isPublic
- is this visible to other peopleviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 questionCommentGUID, String answerCommentGUID, String viewServiceURLMarker, String accessServiceURLMarker, 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 toquestionCommentGUID
- unique identifier of the comment containing the questionanswerCommentGUID
- unique identifier of the comment containing the accepted answerviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 questionCommentGUID, String answerCommentGUID, String viewServiceURLMarker, String accessServiceURLMarker, 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 toquestionCommentGUID
- unique identifier of the comment containing the questionanswerCommentGUID
- unique identifier of the comment containing the accepted answerviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 elementGUID, String commentGUID, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestelementGUID
- String - unique id for the element objectcommentGUID
- String - unique id for the comment objectviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 CommentResponse getCommentByGUID(String serverName, String commentGUID, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the requested comment.- Parameters:
serverName
- name of the server instances for this requestcommentGUID
- 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 callforLineage
- 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 elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the comments attached to an element.- Parameters:
serverName
- name of the server instances for this requestelementGUID
- 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 callforLineage
- 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.
-
findComments
public CommentElementsResponse findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of comment metadata elements that contain the search string. The search string is treated as a regular expression.- Parameters:
serverName
- name of the server to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?viewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createInformalTag
public GUIDResponse createInformalTag(String serverName, String viewServiceURLMarker, String accessServiceURLMarker, TagProperties requestBody) Creates a new informal tag and returns the unique identifier for it.- Parameters:
serverName
- name of the server instances for this requestviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- contains the name of the tag and (optional) description of the tag- Returns:
- guid for new tag or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
updateTagDescription
public VoidResponse updateTagDescription(String serverName, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, InformalTagUpdateRequestBody requestBody) Updates the description of an existing tag (either private or public).- Parameters:
serverName
- name of the server instances for this requesttagGUID
- 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 callrequestBody
- contains the name of the tag and (optional) description of the tag.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
deleteTag
public VoidResponse deleteTag(String serverName, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a tag from the repository. All the relationships to referenceables are lost.- Parameters:
serverName
- name of the server instances for this requesttagGUID
- 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 callrequestBody
- 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 viewServiceURLMarker, String accessServiceURLMarker, String guid) Return the tag for the supplied unique identifier (guid).- Parameters:
serverName
- name of the server instances for this requestguid
- unique identifier 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- 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, NameRequestBody requestBody, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) Return the list of tags exactly matching the supplied name.- Parameters:
serverName
- name of the server instances for this requestrequestBody
- 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:
- 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, NameRequestBody requestBody, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) Return the list of the calling user's private tags exactly matching the supplied name.- Parameters:
serverName
- name of the server instances for this requestrequestBody
- 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:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
findTags
public InformalTagsResponse findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, SearchStringRequestBody requestBody) Return the list of tags containing the supplied string in either the name or description.- Parameters:
serverName
- name of the server to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?viewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- string to find in the properties- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
findMyTags
public InformalTagsResponse findMyTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, SearchStringRequestBody requestBody) Return the list of the calling user's private tags containing the supplied string in either the name or description.- Parameters:
serverName
- name of the server to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?viewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callrequestBody
- string to find in the properties- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
addTagToElement
public VoidResponse addTagToElement(String serverName, String elementGUID, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, FeedbackProperties requestBody) Adds a tag (either private of public) to an element.- Parameters:
serverName
- name of the server instances for this requestelementGUID
- 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 callrequestBody
- feedback request body.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
removeTagFromElement
public VoidResponse removeTagFromElement(String serverName, String elementGUID, String tagGUID, String viewServiceURLMarker, String accessServiceURLMarker, NullRequestBody requestBody) Removes a tag from the element that was added by this user.- Parameters:
serverName
- name of the server instances for this requestelementGUID
- unique id for the element.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 callrequestBody
- 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 RelatedElementsResponse getElementsByTag(String serverName, String tagGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker) 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 requesttagGUID
- 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- 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.
-
findNoteLogs
public NoteLogsResponse findNoteLogs(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, 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 to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?viewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogsByName
public NoteLogsResponse getNoteLogsByName(String serverName, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, 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 requeststartFrom
- paging start pointpageSize
- maximum results that can be returnedviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 NoteLogsResponse getNoteLogsForElement(String serverName, String elementGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestelementGUID
- unique identifier of the note log of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 NoteLogResponse getNoteLogByGUID(String serverName, String noteLogGUID, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestnoteLogGUID
- unique identifier of the requested metadata elementviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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)
-
findNotes
public NotesResponse findNotes(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, String viewServiceURLMarker, String accessServiceURLMarker, 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 to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callstartsWith
- does the value start with the supplied string?endsWith
- does the value end with the supplied string?ignoreCase
- should the search ignore case?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNotesForNoteLog
public NotesResponse getNotesForNoteLog(String serverName, String noteLogGUID, int startFrom, int pageSize, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestnoteLogGUID
- unique identifier of the note log of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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 NoteResponse getNoteByGUID(String serverName, String noteGUID, String viewServiceURLMarker, String accessServiceURLMarker, 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 requestnoteGUID
- unique identifier of the requested metadata elementviewServiceURLMarker
- optional view service URL marker (overrides accessServiceURLMarker)accessServiceURLMarker
- optional access service URL marker used to identify which back end service to callforLineage
- 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)
-