Class GlossaryBrowserRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.glossarybrowser.server.GlossaryBrowserRESTServices
The GlossaryBrowserRESTServices provides the implementation of the Glossary Browser Open Metadata View Service (OMVS).
This interface provides view interfaces for glossary UIs.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCommentReply
(String serverName, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a reply to a comment.addCommentToElement
(String serverName, String guid, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Adds a comment to the element.addLikeToElement
(String serverName, String guid, boolean isPublic, NullRequestBody requestBody) Adds a "LikeProperties" to the element.addRatingToElement
(String serverName, String guid, boolean isPublic, RatingProperties requestBody) Adds a star rating and optional review text to the element.addTagToElement
(String serverName, String elementGUID, String tagGUID, FeedbackProperties requestBody) Adds a tag (either private of public) to an element.clearAcceptedAnswer
(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Unlink a comment that contains an answer to a question posed in another comment.createInformalTag
(String serverName, TagProperties requestBody) Creates a new informal tag and returns the unique identifier for it.deleteTag
(String serverName, String tagGUID, NullRequestBody requestBody) Removes a tag from the repository.findComments
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of comment metadata elements that contain the search string.findGlossaries
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of glossary metadata elements that contain the search string.findGlossaryCategories
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary category metadata elements that contain the search string.findGlossaryTerms
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary term metadata elements that contain the search string.findMyTags
(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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, 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, 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, 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, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the comments attached to an element.getCategoriesForGlossary
(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary.getCategoriesForTerm
(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary term.getCommentByGUID
(String serverName, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the requested comment.getConfidenceClassifiedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.getConfidentialityClassifiedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidentiality classification.getCriticalityClassifiedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the criticality classification.getDataFieldClassifiedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the data field classification.getElementsByTag
(String serverName, String tagGUID, int startFrom, int pageSize) Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.getElementsSourceFrom
(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.getGlossariesByName
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of glossary metadata elements with a matching qualified or display name.getGlossaryByGUID
(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element with the supplied unique identifier.getGlossaryCategoriesByName
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary category metadata elements with a matching qualified or display name.getGlossaryCategoryByGUID
(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.getGlossaryCategoryParent
(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.getGlossaryForCategory
(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested category.getGlossaryForTerm
(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested term.getGlossarySubCategories
(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.getGlossaryTermActivityTypes
(String serverName) Return the list of glossary term activity types enum values.getGlossaryTermByGUID
(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary term metadata element with the supplied unique identifier.getGlossaryTermHistory
(String serverName, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody) Retrieve all the versions of a glossary term.getGlossaryTermRelationshipStatuses
(String serverName) Return the list of glossary term relationship status enum values.getGlossaryTermsByName
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary term metadata elements with a matching qualified or display name.getGlossaryTermStatuses
(String serverName) Return the list of glossary term status enum values.getGovernedByDefinitions
(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.getGovernedElements
(String serverName, String governanceDefinitionGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.getMeanings
(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.getMembersOfSubjectArea
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.getMyTagsByName
(String serverName, NameRequestBody requestBody, int startFrom, int pageSize) Return the list of the calling user's private tags exactly matching the supplied name.getNoteByGUID
(String serverName, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note metadata element with the supplied unique identifier.getNoteLogByGUID
(String serverName, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note log metadata element with the supplied unique identifier.getNoteLogsByName
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of note log metadata elements with a matching qualified or display name.getNoteLogsForElement
(String serverName, String elementGUID, int startFrom, int pageSize, 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, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of notes associated with a note log.getOwnersElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.getRelatedTerms
(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with the requested term.getRetentionClassifiedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.getSecurityTaggedElements
(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the security tags classification.getSemanticAssignees
(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.getSourceElements
(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "SourceFrom" relationship to the requested element.Return the tag for the supplied unique identifier (guid).getTagsByName
(String serverName, NameRequestBody requestBody, int startFrom, int pageSize) Return the list of tags exactly matching the supplied name.getTermsForGlossary
(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary.getTermsForGlossaryCategory
(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary category.removeCommentFromElement
(String serverName, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Removes a comment added to the element by this user.removeLikeFromElement
(String serverName, String guid, NullRequestBody requestBody) Removes a "LikeProperties" added to the element by this user.removeRatingFromElement
(String serverName, String guid, NullRequestBody requestBody) Removes a star rating that was added to the element by this user.removeTagFromElement
(String serverName, String elementGUID, String tagGUID, NullRequestBody requestBody) Removes a tag from the element that was added by this user.setupAcceptedAnswer
(String serverName, String questionCommentGUID, String answerCommentGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link a comment that contains the best answer to a question posed in another comment.updateComment
(String serverName, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update an existing comment.updateTagDescription
(String serverName, String tagGUID, 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
-
GlossaryBrowserRESTServices
public GlossaryBrowserRESTServices()Default constructor
-
-
Method Details
-
getGlossaryTermStatuses
Return the list of glossary term status enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
getGlossaryTermRelationshipStatuses
public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(String serverName) Return the list of glossary term relationship status enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
getGlossaryTermActivityTypes
Return the list of glossary term activity types enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
findGlossaries
public GlossaryElementsResponse findGlossaries(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of glossary 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?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)
-
getGlossariesByName
public GlossaryElementsResponse getGlossariesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- name to search for- 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)
-
getGlossaryByGUID
public GlossaryElementResponse getGlossaryByGUID(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryForCategory
public GlossaryElementResponse getGlossaryForCategory(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested category.- Parameters:
serverName
- name of the server to route the request toglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryForTerm
public GlossaryElementResponse getGlossaryForTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
findGlossaryCategories
public GlossaryCategoryElementsResponse findGlossaryCategories(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary category 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?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- string to find in the properties and correlators- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getCategoriesForGlossary
public GlossaryCategoryElementsResponse getCategoriesForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the glossary to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of metadata elements describing the categories associated with the requested glossary 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)
-
getCategoriesForTerm
public GlossaryCategoryElementsResponse getCategoriesForTerm(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the glossary to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of metadata elements describing the categories associated with the requested glossary 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)
-
getGlossaryCategoriesByName
public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request torequestBody
- name to search for and correlatorsstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?- 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)
-
getGlossaryCategoryByGUID
public GlossaryCategoryElementResponse getGlossaryCategoryByGUID(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request toglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- 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)
-
getGlossaryCategoryParent
public GlossaryCategoryElementResponse getGlossaryCategoryParent(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request toglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- parent glossary category element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
getGlossarySubCategories
public GlossaryCategoryElementsResponse getGlossarySubCategories(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request toglossaryCategoryGUID
- unique identifier of the requested metadata elementstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of glossary category elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
-
findGlossaryTerms
public GlossaryTermElementsResponse findGlossaryTerms(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary term 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?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers and search string- 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)
-
getTermsForGlossary
public GlossaryTermElementsResponse getTermsForGlossary(String serverName, String glossaryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the glossary of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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)
-
getTermsForGlossaryCategory
public GlossaryTermElementsResponse getTermsForGlossaryCategory(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary category.- Parameters:
serverName
- name of the server to route the request toglossaryCategoryGUID
- unique identifier of the glossary category of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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)
-
getRelatedTerms
public GlossaryTermElementsResponse getRelatedTerms(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with the requested term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the glossary of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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)
-
getGlossaryTermsByName
public GlossaryTermElementsResponse getGlossaryTermsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server to route the request tostartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers and name- 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)
-
getGlossaryTermByGUID
public GlossaryTermElementResponse getGlossaryTermByGUID(String serverName, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary term metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request toguid
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryTermHistory
public GlossaryTermElementsResponse getGlossaryTermHistory(String serverName, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody) Retrieve all the versions of a glossary term.- Parameters:
serverName
- name of the server to route the request toguid
- unique identifier of object to retrievestartFrom
- the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.pageSize
- the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.oldestFirst
- defining how the results should be ordered.forLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicaterequestBody
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)- Returns:
- list of beans or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem removing the properties from the repositories. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addRatingToElement
public VoidResponse addRatingToElement(String serverName, String guid, boolean isPublic, RatingProperties requestBody) Adds a star rating and optional review text to the element. If the user has already attached a rating then the original one is over-ridden.- Parameters:
serverName
- name of the server instances for this requestguid
- String - unique id for the element.isPublic
- is this visible to other peoplerequestBody
- 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, 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 objectrequestBody
- 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, 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 peoplerequestBody
- 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, 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 objectrequestBody
- 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, 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 peopleforLineage
- 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, 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 peopleforLineage
- 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, 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 peopleforLineage
- 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, 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 answerforLineage
- 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, 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 answerforLineage
- 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, 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 objectforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- null request body needed to satisfy the HTTP Post request- Returns:
- void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getCommentByGUID
public CommentElementResponse getCommentByGUID(String serverName, String commentGUID, 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.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- effectiveTime and asset manager identifiers- Returns:
- comment properties or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
getAttachedComments
public CommentElementsResponse getAttachedComments(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the comments attached to an element.- Parameters:
serverName
- name of the server instances for this 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.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- effectiveTime and asset manager identifiers- Returns:
- list of comments or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem updating the element properties in the property server. UserNotAuthorizedException the user does not have permission to perform this request.
-
findComments
public CommentElementsResponse findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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?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)
-
createInformalTag
Creates a new informal tag and returns the unique identifier for it.- Parameters:
serverName
- name of the server instances for this requestrequestBody
- 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, 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.requestBody
- contains the name of the tag and (optional) description of the tag.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
deleteTag
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.requestBody
- null request body.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getTag
Return the tag for the supplied unique identifier (guid).- Parameters:
serverName
- name of the server instances for this requestguid
- unique identifier of the tag.- Returns:
- Tag object or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getTagsByName
public InformalTagsResponse getTagsByName(String serverName, NameRequestBody requestBody, int startFrom, int pageSize) Return the list of tags exactly matching the supplied name.- Parameters:
serverName
- name of the server instances for this requestrequestBody
- name of tag.startFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getMyTagsByName
public InformalTagsResponse getMyTagsByName(String serverName, NameRequestBody requestBody, int startFrom, int pageSize) Return the list of the calling user's private tags exactly matching the supplied name.- Parameters:
serverName
- name of the server instances for this requestrequestBody
- name of tag.startFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
findTags
public InformalTagsResponse findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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?requestBody
- string to find in the properties- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
findMyTags
public InformalTagsResponse findMyTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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?requestBody
- string to find in the properties- Returns:
- tag list or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
addTagToElement
public VoidResponse addTagToElement(String serverName, String elementGUID, String tagGUID, 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.requestBody
- feedback request body.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
removeTagFromElement
public VoidResponse removeTagFromElement(String serverName, String elementGUID, String tagGUID, 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.requestBody
- null request body needed for correct protocol exchange.- Returns:
- void or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
-
getElementsByTag
public GUIDListResponse getElementsByTag(String serverName, String tagGUID, int startFrom, int pageSize) Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.- Parameters:
serverName
- name of the server instances for this requesttagGUID
- unique identifier of tag.startFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.- Returns:
- element guid list or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
findNoteLogs
public NoteLogElementsResponse findNoteLogs(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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?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)
-
getNoteLogsByName
public NoteLogElementsResponse getNoteLogsByName(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of note log metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Parameters:
serverName
- name of the server instances for this requeststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- name to search for and correlators- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogsForElement
public NoteLogElementsResponse getNoteLogsForElement(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of note log metadata elements attached to the element.- Parameters:
serverName
- name of the server instances for this requestelementGUID
- unique identifier of the note log of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteLogByGUID
public NoteLogElementResponse getNoteLogByGUID(String serverName, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note log metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server instances for this requestnoteLogGUID
- unique identifier of the requested metadata elementforLineage
- 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 NoteElementsResponse findNotes(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, 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 returnedstartsWith
- 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 NoteElementsResponse getNotesForNoteLog(String serverName, String noteLogGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of notes associated with a note log.- Parameters:
serverName
- name of the server instances for this requestnoteLogGUID
- unique identifier of the note log of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getNoteByGUID
public NoteElementResponse getNoteByGUID(String serverName, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the note metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server instances for this requestnoteGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
getDataFieldClassifiedElements
public ElementStubsResponse getDataFieldClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the data field classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getConfidenceClassifiedElements
public ElementStubsResponse getConfidenceClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getCriticalityClassifiedElements
public ElementStubsResponse getCriticalityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the criticality classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getConfidentialityClassifiedElements
public ElementStubsResponse getConfidentialityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidentiality classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getRetentionClassifiedElements
public ElementStubsResponse getRetentionClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getSecurityTaggedElements
public ElementStubsResponse getSecurityTaggedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the security tags classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getOwnersElements
public ElementStubsResponse getOwnersElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getMembersOfSubjectArea
public ElementStubsResponse getMembersOfSubjectArea(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody) Return information about the elements classified with the confidence classification.- Parameters:
serverName
- name of the server instance to connect tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getMeanings
public GlossaryTermElementsResponse getMeanings(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the element that is being assigned to the glossary termstartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getSemanticAssignees
public RelatedElementsResponse getSemanticAssignees(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.- Parameters:
serverName
- name of the server instance to connect toglossaryTermGUID
- unique identifier of the glossary term that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getGovernedElements
public RelatedElementsResponse getGovernedElements(String serverName, String governanceDefinitionGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.- Parameters:
serverName
- name of the server instance to connect togovernanceDefinitionGUID
- unique identifier of the governance definition that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getGovernedByDefinitions
public GovernanceDefinitionsResponse getGovernedByDefinitions(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the element that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getSourceElements
public RelatedElementsResponse getSourceElements(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were used to create the requested element. Typically only one element is returned.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the governance definition that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-
getElementsSourceFrom
public RelatedElementsResponse getElementsSourceFrom(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the elements linked via a "SourceFrom" relationship to the requested element. The elements returned were created using the requested element as a template.- Parameters:
serverName
- name of the server instance to connect toelementGUID
- unique identifier of the element that the returned elements are linked tostartFrom
- index of the list to start from (0 for start)pageSize
- maximum number of elements to return.forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for relationship request- Returns:
- void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
-