java.lang.Object

org.odpi.openmetadata.viewservices.glossarybrowser.server.spring.GlossaryBrowserResource

@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/glossary-browser") public class GlossaryBrowserResource extends Object

The GlossaryBrowserResource provides the Spring API endpoints of the Glossary Browser Open Metadata View Service (OMVS). This interface provides an interfaces for Egeria UIs.

Constructor Summary

Constructors

Constructor

Description

GlossaryBrowserResource()

Default constructor
Method Summary

Modifier and Type

Method

Description

GUIDResponse

addCommentReply(String serverName, String commentGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)

Adds a reply to a comment.

GUIDResponse

addCommentToElement(String serverName, String elementGUID, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)

Creates a comment and attaches it to an element.

VoidResponse

addLikeToElement(String serverName, String elementGUID, boolean isPublic, NullRequestBody requestBody)

Creates a "like" object and attaches it to an element.

VoidResponse

addRatingToElement(String serverName, String elementGUID, boolean isPublic, RatingProperties requestBody)

Adds a star rating and optional review text to the element.

VoidResponse

addTagToElement(String serverName, String elementGUID, String tagGUID, FeedbackProperties requestBody)

Adds an informal tag (either private of public) to an element.

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.

GUIDResponse

createInformalTag(String serverName, TagProperties requestBody)

Creates a new informal tag and returns the unique identifier for it.

VoidResponse

deleteTag(String serverName, String tagGUID, NullRequestBody requestBody)

Removes an informal tag from the repository.

CommentElementsResponse

findComments(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody)

Return the list of comments containing the supplied string.

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.

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.

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.

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.

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.

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.

InformalTagsResponse

findTags(String serverName, int startFrom, int pageSize, boolean startsWith, boolean endsWith, boolean ignoreCase, SearchStringRequestBody requestBody)

Return the list of comments containing the supplied string in the text.

CommentElementsResponse

getAttachedComments(String serverName, String elementGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Return the comments attached to an element.

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.

GlossaryCategoryElementsResponse

getCategoriesForTerm(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Return the list of categories associated with a term.

CommentElementResponse

getComment(String serverName, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Return the requested comment.

ElementStubsResponse

getConfidenceClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the confidence classification.

ElementStubsResponse

getConfidentialityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the confidentiality classification.

ElementStubsResponse

getCriticalityClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the criticality classification.

ElementStubsResponse

getDataFieldClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the confidence classification.

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.

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.

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.

GlossaryElementResponse

getGlossaryByGUID(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the glossary metadata element with the supplied unique identifier.

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.

GlossaryCategoryElementResponse

getGlossaryCategoryByGUID(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the glossary category metadata element with the supplied unique identifier.

GlossaryCategoryElementResponse

getGlossaryCategoryParent(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the parent glossary category metadata element for the glossary category with the supplied unique identifier.

GlossaryElementResponse

getGlossaryForCategory(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the glossary metadata element for the requested category.

GlossaryElementResponse

getGlossaryForTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the glossary metadata element for the requested term.

GlossaryCategoryElementsResponse

getGlossarySubCategories(String serverName, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the subcategories for the glossary category metadata element with the supplied unique identifier.

GlossaryTermActivityTypeListResponse

getGlossaryTermActivityTypes(String serverName)

Return the list of glossary term activity type enum values.

GlossaryTermElementResponse

getGlossaryTermByGUID(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the glossary term metadata element with the supplied unique identifier.

GlossaryTermElementsResponse

getGlossaryTermHistory(String serverName, String glossaryTermGUID, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryRequestBody requestBody)

Retrieve all the versions of a glossary term.

GlossaryTermRelationshipStatusListResponse

getGlossaryTermRelationshipStatuses(String serverName)

Return the list of glossary term relationship status enum values.

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.

GlossaryTermStatusListResponse

getGlossaryTermStatuses(String serverName)

Return the list of glossary term status enum values.

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.

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.

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.

ElementStubsResponse

getMembersOfSubjectArea(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the security tags classification.

InformalTagsResponse

getMyTagsByName(String serverName, int startFrom, int pageSize, NameRequestBody requestBody)

Return the list of the calling user's private informal tags exactly matching the supplied name.

NoteElementResponse

getNoteByGUID(String serverName, String noteGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the note metadata element with the supplied unique identifier.

NoteLogElementResponse

getNoteLogByGUID(String serverName, String noteLogGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)

Retrieve the note log metadata element with the supplied unique identifier.

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.

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.

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.

ElementStubsResponse

getOwnersElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the security tags classification.

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 glossary term.

ElementStubsResponse

getRetentionClassifiedElements(String serverName, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, FindByPropertiesRequestBody requestBody)

Return information about the elements classified with the confidence classification.

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.

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.

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.

InformalTagResponse

getTag(String serverName, String tagGUID)

Return the informal tag for the supplied unique identifier (tagGUID).

InformalTagsResponse

getTagsByName(String serverName, int startFrom, int pageSize, NameRequestBody requestBody)

Return the tags exactly matching the supplied name.

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.

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.

VoidResponse

removeCommentFromElement(String serverName, String elementGUID, String commentGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)

Removes a comment added to the element by this user.

VoidResponse

removeLikeFromElement(String serverName, String elementGUID, NullRequestBody requestBody)

Removes a "Like" added to the element by this user.

VoidResponse

removeRatingFromElement(String serverName, String elementGUID, NullRequestBody requestBody)

Removes of a star rating/review that was added to the element by this user.

VoidResponse

removeTagFromElement(String serverName, String elementGUID, String tagGUID, NullRequestBody requestBody)

Removes a link between a tag and an element that was added by this user.

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.

VoidResponse

updateComment(String serverName, String commentGUID, boolean isMergeUpdate, boolean isPublic, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)

Update an existing comment.

VoidResponse

updateTagDescription(String serverName, String tagGUID, InformalTagUpdateRequestBody requestBody)

Updates the description of an existing tag (either private or public).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- GlossaryBrowserResource
  
  public GlossaryBrowserResource()
  
  Default constructor
Method Details
- getGlossaryTermStatuses
  
  @GetMapping(path="/glossaries/terms/status-list") public GlossaryTermStatusListResponse getGlossaryTermStatuses(@PathVariable String serverName)
  
  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
  
  @GetMapping(path="/glossaries/terms/relationships/status-list") public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(@PathVariable 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
  
  @GetMapping(path="/glossaries/terms/activity-types") public GlossaryTermActivityTypeListResponse getGlossaryTermActivityTypes(@PathVariable String serverName)
  
  Return the list of glossary term activity type enum values.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  Returns:
  
  list of enum values
- findGlossaries
  
  @PostMapping(path="/glossaries/by-search-string") public GlossaryElementsResponse findGlossaries(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody SearchStringRequestBody requestBody)
  
  Retrieve the list of glossary metadata elements that contain the search string.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  requestBody - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  forLineage - 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)
- getGlossariesByName
  
  @PostMapping(path="/glossaries/by-name") public GlossaryElementsResponse getGlossariesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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 to
  
  requestBody - name to search for
  
  startFrom - paging start point
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  pageSize - maximum results that can be returned
  
  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
  
  @PostMapping(path="/glossaries/{glossaryGUID}/retrieve") public GlossaryElementResponse getGlossaryByGUID(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getGlossaryForCategory
  
  @PostMapping(path="/glossaries/for-category/{glossaryCategoryGUID}/retrieve") public GlossaryElementResponse getGlossaryForCategory(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary metadata element for the requested category.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryCategoryGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getGlossaryForTerm
  
  @PostMapping(path="/glossaries/for-term/{glossaryTermGUID}/retrieve") public GlossaryElementResponse getGlossaryForTerm(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary metadata element for the requested term.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryTermGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- findGlossaryCategories
  
  @PostMapping(path="/glossaries/categories/by-search-string") public GlossaryCategoryElementsResponse findGlossaryCategories(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody GlossarySearchStringRequestBody requestBody)
  
  Retrieve the list of glossary category metadata elements that contain the search string.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  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
  
  @PostMapping(path="/glossaries/{glossaryGUID}/categories/retrieve") public GlossaryCategoryElementsResponse getCategoriesForGlossary(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Return the list of categories associated with a glossary.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryGUID - unique identifier of the glossary to query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of 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
  
  @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/categories/retrieve") public GlossaryCategoryElementsResponse getCategoriesForTerm(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Return the list of categories associated with a term.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryTermGUID - unique identifier of the glossary to query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of 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
  
  @PostMapping(path="/glossaries/categories/by-name") public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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 to
  
  requestBody - name to search for and correlators
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  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
  
  @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/retrieve") public GlossaryCategoryElementResponse getGlossaryCategoryByGUID(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary category metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryCategoryGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  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
  
  @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/parent/retrieve") public GlossaryCategoryElementResponse getGlossaryCategoryParent(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the parent glossary category metadata element for the glossary category with the supplied unique identifier. If the requested category does not have a parent category, null is returned.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryCategoryGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  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
  
  @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/subcategories/retrieve") public GlossaryCategoryElementsResponse getGlossarySubCategories(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the subcategories for the glossary category metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryCategoryGUID - unique identifier of the requested metadata element
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of 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
  
  @PostMapping(path="/glossaries/terms/by-search-string") public GlossaryTermElementsResponse findGlossaryTerms(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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 to
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  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
  
  @PostMapping(path="/glossaries/{glossaryGUID}/terms/retrieve") public GlossaryTermElementsResponse getTermsForGlossary(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the list of glossary terms associated with a glossary.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryGUID - unique identifier of the glossary of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getTermsForGlossaryCategory
  
  @PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/terms/retrieve") public GlossaryTermElementsResponse getTermsForGlossaryCategory(@PathVariable String serverName, @PathVariable String glossaryCategoryGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) GlossaryTermRelationshipRequestBody requestBody)
  
  Retrieve the list of glossary terms associated with a glossary category.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryCategoryGUID - unique identifier of the glossary category of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getRelatedTerms
  
  @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/related-terms") public GlossaryTermElementsResponse getRelatedTerms(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) GlossaryTermRelationshipRequestBody requestBody)
  
  Retrieve the list of glossary terms associated with the requested glossary term.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryTermGUID - unique identifier of the glossary of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getGlossaryTermsByName
  
  @PostMapping(path="/glossaries/terms/by-name") public GlossaryTermElementsResponse getGlossaryTermsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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 to
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers 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
  
  @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/retrieve") public GlossaryTermElementResponse getGlossaryTermByGUID(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary term metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryTermGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getGlossaryTermHistory
  
  @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/history") public GlossaryTermElementsResponse getGlossaryTermHistory(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean oldestFirst, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) HistoryRequestBody requestBody)
  
  Retrieve all the versions of a glossary term.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  glossaryTermGUID - unique identifier of object to retrieve
  
  startFrom - 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 returned
  
  forDuplicateProcessing - the request is for duplicate processing and so must not deduplicate
  
  requestBody - 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.
- addCommentReply
  
  @PostMapping(path="/comments/{commentGUID}/replies") public GUIDResponse addCommentReply(@PathVariable String serverName, @PathVariable String commentGUID, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody ReferenceableUpdateRequestBody requestBody)
  
  Adds a reply to a comment.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  commentGUID - String - unique id for an existing comment. Used to add a reply to a comment.
  
  isPublic - is this visible to other people
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- addCommentToElement
  
  @PostMapping(path="/elements/{elementGUID}/comments") public GUIDResponse addCommentToElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody ReferenceableUpdateRequestBody requestBody)
  
  Creates a comment and attaches it to an element.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - String - unique id for the element.
  
  isPublic - is this visible to other people
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  elementGUID for new comment object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- addLikeToElement
  
  @PostMapping(path="/elements/{elementGUID}/likes") public VoidResponse addLikeToElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestBody(required=false) NullRequestBody requestBody)
  
  Creates a "like" object and attaches it to an element.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - String - unique id for the element.
  
  isPublic - is this visible to other people
  
  requestBody - feedback request body.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- addRatingToElement
  
  @PostMapping(path="/elements/{elementGUID}/ratings") public VoidResponse addRatingToElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam boolean isPublic, @RequestBody RatingProperties requestBody)
  
  Adds a star rating and optional review text to the element.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - String - unique id for the element.
  
  isPublic - is this visible to other people
  
  requestBody - containing the StarRating and user review of element.
  
  Returns:
  
  elementGUID for new review object or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- addTagToElement
  
  @PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}") public VoidResponse addTagToElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody FeedbackProperties requestBody)
  
  Adds an informal tag (either private of public) to an element.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - unique id for the element.
  
  tagGUID - unique id of the tag.
  
  requestBody - null request body needed for correct protocol exchange.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- createInformalTag
  
  @PostMapping(path="/tags") public GUIDResponse createInformalTag(@PathVariable String serverName, @RequestBody TagProperties requestBody)
  
  Creates a new informal tag and returns the unique identifier for it.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  requestBody - public/private flag, name of the tag and (optional) description of the tag.
  
  Returns:
  
  new elementGUID or InvalidParameterException one of the parameters is null or invalid or PropertyServerException There is a problem adding the element properties to the metadata repository or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- deleteTag
  
  @PostMapping(path="/tags/{tagGUID}/remove") public VoidResponse deleteTag(@PathVariable String serverName, @PathVariable String tagGUID, @RequestBody(required=false) NullRequestBody requestBody)
  
  Removes an informal tag from the repository. All the tagging relationships to this informal tag are lost. A private tag can be deleted by its creator and all the references are lost; a public tag can be deleted by anyone, but only if it is not attached to any referenceable.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  tagGUID - String - unique id for the tag.
  
  requestBody - null request body.
  
  Returns:
  
  void or InvalidParameterException - one of the parameters is null or invalid or PropertyServerException - there is a problem updating the element properties in the metadata repository or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- getElementsByTag
  
  @GetMapping(path="/elements/by-tag/{tagGUID}") public GUIDListResponse getElementsByTag(@PathVariable String serverName, @PathVariable String tagGUID, @RequestParam int startFrom, @RequestParam int pageSize)
  
  Return the list of unique identifiers for elements that are linked to a specific tag either directly, or via one of its schema elements.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  tagGUID - unique identifier of tag.
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  element guid list or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- getTag
  
  @GetMapping(path="/tags/{tagGUID}") public InformalTagResponse getTag(@PathVariable String serverName, @PathVariable String tagGUID)
  
  Return the informal tag for the supplied unique identifier (tagGUID).
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  tagGUID - unique identifier of the meaning.
  
  Returns:
  
  tag object or InvalidParameterException the userId is null or invalid or PropertyServerException there is a problem retrieving information from the property server(s) or UserNotAuthorizedException the requesting user is not authorized to issue this request.
- getTagsByName
  
  @PostMapping(path="/tags/by-name") public InformalTagsResponse getTagsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
  
  Return the tags exactly matching the supplied name.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  requestBody - name of tag.
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- getMyTagsByName
  
  @PostMapping(path="/tags/private/by-name") public InformalTagsResponse getMyTagsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
  
  Return the list of the calling user's private informal tags exactly matching the supplied name.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  requestBody - name of tag.
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- findComments
  
  @PostMapping(path="/comments/by-search-string") public CommentElementsResponse findComments(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody SearchStringRequestBody requestBody)
  
  Return the list of comments containing the supplied string.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - search string and effective time.
  
  Returns:
  
  list of comment objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- findTags
  
  @PostMapping(path="/tags/by-search-string") public InformalTagsResponse findTags(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody SearchStringRequestBody requestBody)
  
  Return the list of comments containing the supplied string in the text. The search string is a regular expression (RegEx).
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  requestBody - search string and effective time.
  
  Returns:
  
  list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- findMyTags
  
  @PostMapping(path="/tags/private/by-search-string") public InformalTagsResponse findMyTags(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestBody SearchStringRequestBody requestBody)
  
  Return the list of the calling user's private tags containing the supplied string in either the name or description. The search string is a regular expression (RegEx).
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  requestBody - search string and effective time.
  
  Returns:
  
  list of tag objects or InvalidParameterException - one of the parameters is invalid or PropertyServerException - there is a problem retrieving information from the property server(s) or UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- removeCommentFromElement
  
  @PostMapping(path="/elements/{elementGUID}/comments/{commentGUID}/remove") public VoidResponse removeCommentFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) ReferenceableUpdateRequestBody requestBody)
  
  Removes a comment added to the element by this user. This deletes the link to the comment, the comment itself and any comment replies attached to it.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  elementGUID - String - unique id for the element object
  
  commentGUID - String - unique id for the comment object
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the user does not have permission to perform this request.
- getComment
  
  @PostMapping(path="/comments/{commentGUID}") public CommentElementResponse getComment(@PathVariable String serverName, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Return the requested comment.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  commentGUID - unique identifier for the comment object.
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - properties controlling the request
  
  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
  
  @PostMapping(path="/elements/{elementGUID}/comments/retrieve") public CommentElementsResponse getAttachedComments(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Return the comments attached to an element.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  elementGUID - unique identifier for the element that the comments are connected to (maybe a comment too).
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - properties controlling the request
  
  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.
- removeLikeFromElement
  
  @PostMapping(path="/elements/{elementGUID}/likes/remove") public VoidResponse removeLikeFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NullRequestBody requestBody)
  
  Removes a "Like" added to the element by this user.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - unique identifier for the element where the like is attached.
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- removeRatingFromElement
  
  @PostMapping(path="/elements/{elementGUID}/ratings/remove") public VoidResponse removeRatingFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestBody(required=false) NullRequestBody requestBody)
  
  Removes of a star rating/review that was added to the element by this user.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - unique identifier for the element where the rating is attached.
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- removeTagFromElement
  
  @PostMapping(path="/elements/{elementGUID}/tags/{tagGUID}/remove") public VoidResponse removeTagFromElement(@PathVariable String serverName, @PathVariable String elementGUID, @PathVariable String tagGUID, @RequestBody(required=false) NullRequestBody requestBody)
  
  Removes a link between a tag and an element that was added by this user.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  elementGUID - unique id for the element.
  
  tagGUID - unique id of the tag.
  
  requestBody - null request body needed for correct protocol exchange.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- updateComment
  
  @PostMapping(path="/comments/{commentGUID}/update") public VoidResponse updateComment(@PathVariable String serverName, @PathVariable String commentGUID, @RequestParam(required=false,defaultValue="false") boolean isMergeUpdate, @RequestParam boolean isPublic, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody 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 people
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - containing type of comment enum and the text of the comment.
  
  Returns:
  
  void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException There is a problem updating the element properties in the metadata repository. UserNotAuthorizedException the requesting user is not authorized to issue this request.
- setupAcceptedAnswer
  
  @PostMapping("/comments/questions/{questionCommentGUID}/answers/{answerCommentGUID}") public VoidResponse setupAcceptedAnswer(@PathVariable String serverName, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody RelationshipRequestBody requestBody)
  
  Link a comment that contains the best answer to a question posed in another comment.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  questionCommentGUID - unique identifier of the comment containing the question
  
  answerCommentGUID - unique identifier of the comment containing the accepted answer
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
  
  Returns:
  
  void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- clearAcceptedAnswer
  
  @PostMapping("/comments/questions/{questionCommentGUID}/answers/{answerCommentGUID}/remove") public VoidResponse clearAcceptedAnswer(@PathVariable String serverName, @PathVariable String questionCommentGUID, @PathVariable String answerCommentGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody EffectiveTimeQueryRequestBody requestBody)
  
  Unlink a comment that contains an answer to a question posed in another comment.
  
  Parameters:
  
  serverName - name of the server to route the request to
  
  questionCommentGUID - unique identifier of the comment containing the question
  
  answerCommentGUID - unique identifier of the comment containing the accepted answer
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
  
  Returns:
  
  void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- updateTagDescription
  
  @PostMapping(path="/tags/{tagGUID}/update") public VoidResponse updateTagDescription(@PathVariable String serverName, @PathVariable String tagGUID, @RequestBody InformalTagUpdateRequestBody requestBody)
  
  Updates the description of an existing tag (either private or public).
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  tagGUID - unique id for the tag
  
  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.
- findNoteLogs
  
  @PostMapping("/note-logs/by-search-string") public NoteLogElementsResponse findNoteLogs(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody SearchStringRequestBody requestBody)
  
  Retrieve the list of note log metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - search string and effective time.
  
  Returns:
  
  list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getNoteLogsByName
  
  @PostMapping("/note-logs/by-name") public NoteLogElementsResponse getNoteLogsByName(@PathVariable String serverName, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody NameRequestBody requestBody)
  
  Retrieve the list of note log metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - name to search for and correlators
  
  Returns:
  
  list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getNoteLogsForElement
  
  @PostMapping("/elements/{elementGUID}/note-logs/retrieve") public NoteLogElementsResponse getNoteLogsForElement(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the list of note log metadata elements attached to the element.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  elementGUID - element to start from
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - name to search for and correlators
  
  Returns:
  
  list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getNoteLogByGUID
  
  @PostMapping("/note-logs/{noteLogGUID}/retrieve") public NoteLogElementResponse getNoteLogByGUID(@PathVariable String serverName, @PathVariable String noteLogGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the note log metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  noteLogGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
  
  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
  
  @PostMapping("/note-logs/notes/by-search-string") public NoteElementsResponse findNotes(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody SearchStringRequestBody requestBody)
  
  Retrieve the list of note metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  serverName - name of the server instances for this request.
  
  startsWith - does the value start with the supplied string?
  
  endsWith - does the value end with the supplied string?
  
  ignoreCase - should the search ignore case?
  
  startFrom - index of the list to start from (0 for start).
  
  pageSize - maximum number of elements to return.
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - search string and effective time.
  
  Returns:
  
  list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getNotesForNoteLog
  
  @PostMapping("/note-logs/{noteLogGUID}/notes/retrieve") public NoteElementsResponse getNotesForNoteLog(@PathVariable String serverName, @PathVariable String noteLogGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the list of notes associated with a note log.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  noteLogGUID - unique identifier of the note log of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getNoteByGUID
  
  @PostMapping("/note-logs/notes/{noteGUID}/retrieve") public NoteElementResponse getNoteByGUID(@PathVariable String serverName, @PathVariable String noteGUID, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the note metadata element with the supplied unique identifier.
  
  Parameters:
  
  serverName - name of the server instances for this request
  
  noteGUID - unique identifier of the requested metadata element
  
  forLineage - return elements marked with the Memento classification?
  
  forDuplicateProcessing - do not merge elements marked as duplicates?
  
  requestBody - asset manager identifiers
  
  Returns:
  
  matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
- getDataFieldClassifiedElements
  
  @PostMapping(path="/elements/by-data-field") public ElementStubsResponse getDataFieldClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the confidence classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getConfidenceClassifiedElements
  
  @PostMapping(path="/elements/by-confidence") public ElementStubsResponse getConfidenceClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the confidence classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getCriticalityClassifiedElements
  
  @PostMapping(path="/elements/by-criticality") public ElementStubsResponse getCriticalityClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the criticality classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getConfidentialityClassifiedElements
  
  @PostMapping(path="/elements/by-confidentiality") public ElementStubsResponse getConfidentialityClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the confidentiality classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getRetentionClassifiedElements
  
  @PostMapping(path="/elements/by-retention") public ElementStubsResponse getRetentionClassifiedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the confidence classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getSecurityTaggedElements
  
  @PostMapping(path="/elements/by-security-tags") public ElementStubsResponse getSecurityTaggedElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the security tags classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getOwnersElements
  
  @PostMapping(path="/elements/by-ownership") public ElementStubsResponse getOwnersElements(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the security tags classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getMembersOfSubjectArea
  
  @PostMapping(path="/elements/by-subject-area-membership") public ElementStubsResponse getMembersOfSubjectArea(@PathVariable String serverName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) FindByPropertiesRequestBody requestBody)
  
  Return information about the elements classified with the security tags classification.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  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 - properties for the request
  
  Returns:
  
  classified elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getMeanings
  
  @PostMapping("/glossaries/terms/by-semantic-assignment/{elementGUID}") public GlossaryTermElementsResponse getMeanings(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  elementGUID - unique identifier of the element that is being assigned to the glossary term
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getSemanticAssignees
  
  @PostMapping("/elements/by-semantic-assignment/{glossaryTermGUID}") public RelatedElementsResponse getSemanticAssignees(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the glossary terms linked via a "SemanticAssignment" relationship to the requested element.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  glossaryTermGUID - unique identifier of the glossary term that the returned elements are linked to
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getGovernedElements
  
  @PostMapping(path="/elements/governed-by/{governanceDefinitionGUID}") public RelatedElementsResponse getGovernedElements(@PathVariable String serverName, @PathVariable String governanceDefinitionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the governance definitions linked via a "GovernedBy" relationship to the requested element.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  governanceDefinitionGUID - unique identifier of the governance definition that the returned elements are linked to
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getGovernedByDefinitions
  
  @PostMapping(path="/elements/{elementGUID}/governed-by") public GovernanceDefinitionsResponse getGovernedByDefinitions(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
  
  Retrieve the elements linked via a "GovernedBy" relationship to the requested governance definition.
  
  Parameters:
  
  serverName - name of the server instance to connect to
  
  elementGUID - unique identifier of the element that the returned elements are linked to
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getSourceElements
  
  @PostMapping(path="/elements/sourced-from/{elementGUID}") public RelatedElementsResponse getSourceElements(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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 to
  
  elementGUID - unique identifier of the element that the returned elements are linked to
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem
- getElementsSourceFrom
  
  @PostMapping(path="/elements/{elementGUID}/sourced-from") public RelatedElementsResponse getElementsSourceFrom(@PathVariable String serverName, @PathVariable String elementGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestParam(required=false,defaultValue="false") boolean forLineage, @RequestParam(required=false,defaultValue="false") boolean forDuplicateProcessing, @RequestBody(required=false) 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 to
  
  elementGUID - unique identifier of the element that the returned elements are linked to
  
  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 - properties for relationship request
  
  Returns:
  
  linked elements or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

Class GlossaryBrowserResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

GlossaryBrowserResource

Method Details

getGlossaryTermStatuses

getGlossaryTermRelationshipStatuses

getGlossaryTermActivityTypes

findGlossaries

getGlossariesByName

getGlossaryByGUID

getGlossaryForCategory

getGlossaryForTerm

findGlossaryCategories

getCategoriesForGlossary

getCategoriesForTerm

getGlossaryCategoriesByName

getGlossaryCategoryByGUID

getGlossaryCategoryParent

getGlossarySubCategories

findGlossaryTerms

getTermsForGlossary

getTermsForGlossaryCategory

getRelatedTerms

getGlossaryTermsByName

getGlossaryTermByGUID

getGlossaryTermHistory

addCommentReply

addCommentToElement

addLikeToElement

addRatingToElement

addTagToElement

createInformalTag

deleteTag

getElementsByTag

getTag

getTagsByName

getMyTagsByName

findComments

findTags

findMyTags

removeCommentFromElement

getComment

getAttachedComments

removeLikeFromElement

removeRatingFromElement

removeTagFromElement

updateComment

setupAcceptedAnswer

clearAcceptedAnswer

updateTagDescription

findNoteLogs

getNoteLogsByName

getNoteLogsForElement

getNoteLogByGUID

findNotes

getNotesForNoteLog

getNoteByGUID

getDataFieldClassifiedElements

getConfidenceClassifiedElements

getCriticalityClassifiedElements

getConfidentialityClassifiedElements

getRetentionClassifiedElements

getSecurityTaggedElements

getOwnersElements

getMembersOfSubjectArea

getMeanings

getSemanticAssignees

getGovernedElements

getGovernedByDefinitions

getSourceElements

getElementsSourceFrom