Package org.odpi.openmetadata.viewservices.glossarymanager.server

Class GlossaryManagerRESTServices

java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.glossarymanager.server.GlossaryManagerRESTServices
public class GlossaryManagerRESTServices extends TokenController
The GlossaryManagerRESTServices provides the implementation of the Glossary ManagerOpen Metadata View Service (OMVS). This interface provides view interfaces for infrastructure and ops users.

  • Constructor Details

    • GlossaryManagerRESTServices

      public GlossaryManagerRESTServices()
      Default constructor

  • Method Details

    • createGlossary

      public GUIDResponse createGlossary(String serverName, ReferenceableRequestBody requestBody)
      Create a new metadata element to represent the root of a glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - properties to store
      Returns:
      unique identifier of the new 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)

    • createGlossaryFromTemplate

      public GUIDResponse createGlossaryFromTemplate(String serverName, String templateGUID, boolean deepCopy, TemplateRequestBody requestBody)
      Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.
      Parameters:
      serverName - name of the server to route the request to
      templateGUID - unique identifier of the metadata element to copy
      deepCopy - should the template creation extend to the anchored elements or just the direct entity?
      requestBody - properties that override the template
      Returns:
      unique identifier of the new 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)

    • updateGlossary

      public VoidResponse updateGlossary(String serverName, String glossaryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Update the metadata element representing a glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the properties be merged with the existing properties or completely over-write them
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for this element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeGlossary

      public VoidResponse removeGlossary(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setGlossaryAsEditingGlossary

      public VoidResponse setGlossaryAsEditingGlossary(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearGlossaryAsEditingGlossary

      public VoidResponse clearGlossaryAsEditingGlossary(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the editing glossary designation from the glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlation properties for the external asset manager
      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)

    • setGlossaryAsStagingGlossary

      public VoidResponse setGlossaryAsStagingGlossary(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary to indicate that it is a staging glossary - this means it is a collection of glossary updates that will be transferred into another glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearGlossaryAsStagingGlossary

      public VoidResponse clearGlossaryAsStagingGlossary(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the staging glossary designation from the glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlation properties for the external asset manager
      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)

    • setGlossaryAsTaxonomy

      public VoidResponse setGlossaryAsTaxonomy(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary to indicate that it can be used as a taxonomy. This means each term is attached to one, and only one category and the categories are organized as a hierarchy with a single root category. Taxonomies are used as a way of organizing assets and other related metadata. The terms in the taxonomy are linked to the assets etc. and as such they are logically categorized by the linked category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearGlossaryAsTaxonomy

      public VoidResponse clearGlossaryAsTaxonomy(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the taxonomy designation from the glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlation properties for the external asset manager
      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)

    • setGlossaryAsCanonical

      public VoidResponse setGlossaryAsCanonical(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name. This means there is only one definition for each term. Typically, the terms are also of a similar level of granularity and are limited to a specific scope of use. Canonical vocabularies are used to semantically classify assets in an unambiguous way.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - description of the situations where this glossary is relevant.
      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)

    • clearGlossaryAsCanonical

      public VoidResponse clearGlossaryAsCanonical(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the canonical designation from the glossary.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - correlation properties for the external asset manager
      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)

    • createGlossaryCategory

      public GUIDResponse createGlossaryCategory(String serverName, String glossaryGUID, boolean isRootCategory, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Create a new metadata element to represent a glossary category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary where the category is located
      isRootCategory - is this category a root category?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties about the glossary category to store
      Returns:
      unique identifier of the new glossary category 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)

    • createGlossaryCategoryFromTemplate

      public GUIDResponse createGlossaryCategoryFromTemplate(String serverName, String glossaryGUID, String templateGUID, TemplateRequestBody requestBody)
      Create a new metadata element to represent a glossary category using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary where the category is located
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new glossary category 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)

    • updateGlossaryCategory

      public VoidResponse updateGlossaryCategory(String serverName, String glossaryCategoryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Update the metadata element representing a glossary category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupCategoryParent

      public VoidResponse setupCategoryParent(String serverName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Create a parent-child relationship between two categories.
      Parameters:
      serverName - name of the server to route the request to
      glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category
      glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory
      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)

    • clearCategoryParent

      public VoidResponse clearCategoryParent(String serverName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove a parent-child relationship between two categories.
      Parameters:
      serverName - name of the server to route the request to
      glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category
      glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory
      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)

    • removeGlossaryCategory

      public VoidResponse removeGlossaryCategory(String serverName, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Remove the metadata element representing a glossary category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossaryTermStatuses

      public GlossaryTermStatusListResponse getGlossaryTermStatuses(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

      public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(String serverName)
      Return the list of glossary term relationship status enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • getGlossaryTermActivityTypes

      public GlossaryTermActivityTypeListResponse getGlossaryTermActivityTypes(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

    • createControlledGlossaryTerm

      public GUIDResponse createControlledGlossaryTerm(String serverName, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ControlledGlossaryTermRequestBody requestBody)
      Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary where the term is to be located
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the glossary term
      Returns:
      unique identifier of the new metadata element for the glossary term 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)

    • createGlossaryTermFromTemplate

      public GUIDResponse createGlossaryTermFromTemplate(String serverName, String glossaryGUID, String templateGUID, boolean deepCopy, boolean templateSubstitute, GlossaryTemplateRequestBody requestBody)
      Create a new metadata element to represent a glossary term using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the glossary where the term is to be located
      templateGUID - unique identifier of the metadata element to copy
      deepCopy - should the template creation extend to the anchored elements or just the direct entity?
      templateSubstitute - is this element a template substitute (used as the "other end" of a new/updated relationship)
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element for the glossary term 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)

    • updateGlossaryTerm

      public VoidResponse updateGlossaryTerm(String serverName, String glossaryTermGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Update the metadata element representing a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary term to update
      isMergeUpdate - should the properties be merged with the existing properties or completely over-write them
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - new properties for the glossary term
      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)

    • updateGlossaryTermStatus

      public VoidResponse updateGlossaryTermStatus(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermStatusRequestBody requestBody)
      Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary term to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - status and correlation properties
      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)

    • updateGlossaryTermFromTemplate

      public VoidResponse updateGlossaryTermFromTemplate(String serverName, String glossaryTermGUID, boolean isMergeClassifications, boolean isMergeProperties, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Update the glossary term using the properties and classifications from the parentGUID stored in the request body.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary term to update
      isMergeClassifications - should the classification be merged or replace the target entity?
      isMergeProperties - should the properties be merged with the existing ones or replace them
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - status and correlation properties
      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)

    • moveGlossaryTerm

      public VoidResponse moveGlossaryTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Move a glossary term from one glossary to another.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the glossary term to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - status and correlation properties
      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)

    • setupTermCategory

      public VoidResponse setupTermCategory(String serverName, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link a term to a category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the glossary category
      glossaryTermGUID - unique identifier of the glossary term
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the categorization relationship
      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)

    • clearTermCategory

      public VoidResponse clearTermCategory(String serverName, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Unlink a term from a category.
      Parameters:
      serverName - name of the server to route the request to
      glossaryCategoryGUID - unique identifier of the glossary category
      glossaryTermGUID - unique identifier of the glossary term
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - asset manager identifiers
      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)

    • getTermRelationshipTypeNames

      public NameListResponse getTermRelationshipTypeNames(String serverName)
      Return the list of term-to-term relationship names.
      Parameters:
      serverName - name of the server instance to connect to
      Returns:
      list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.

    • setupTermRelationship

      public VoidResponse setupTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Link two terms together using a specialist relationship.
      Parameters:
      serverName - name of the server to route the request to
      relationshipTypeName - name of the type of relationship to create
      glossaryTermOneGUID - unique identifier of the glossary term at end 1
      glossaryTermTwoGUID - unique identifier of the glossary term at end 2
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the relationship
      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)

    • updateTermRelationship

      public VoidResponse updateTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody)
      Update the relationship properties for the two terms.
      Parameters:
      serverName - name of the server to route the request to
      relationshipTypeName - name of the type of relationship to create
      glossaryTermOneGUID - unique identifier of the glossary term at end 1
      glossaryTermTwoGUID - unique identifier of the glossary term at end 2
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties for the relationship
      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)

    • clearTermRelationship

      public VoidResponse clearTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Remove the relationship between two terms.
      Parameters:
      serverName - name of the server to route the request to
      relationshipTypeName - name of the type of relationship to create
      glossaryTermOneGUID - unique identifier of the glossary term at end 1
      glossaryTermTwoGUID - unique identifier of the glossary term at end 2
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties of the relationship
      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)

    • setTermAsAbstractConcept

      public VoidResponse setTermAsAbstractConcept(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes an abstract concept.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsAbstractConcept

      public VoidResponse clearTermAsAbstractConcept(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the abstract concept designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsDataField

      public VoidResponse setTermAsDataField(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsDataField

      public VoidResponse clearTermAsDataField(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the data field designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsDataValue

      public VoidResponse setTermAsDataValue(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a data value.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsDataValue

      public VoidResponse clearTermAsDataValue(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the data value designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsActivity

      public VoidResponse setTermAsActivity(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a data value.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - type of activity and correlators
      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)

    • clearTermAsActivity

      public VoidResponse clearTermAsActivity(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the activity designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsContext

      public VoidResponse setTermAsContext(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a context.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - more details of the context
      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)

    • clearTermAsContext

      public VoidResponse clearTermAsContext(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the context definition designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsSpineObject

      public VoidResponse setTermAsSpineObject(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a spine object.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsSpineObject

      public VoidResponse clearTermAsSpineObject(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the spine object designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsSpineAttribute

      public VoidResponse setTermAsSpineAttribute(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes a spine attribute.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsSpineAttribute

      public VoidResponse clearTermAsSpineAttribute(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the spine attribute designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • setTermAsObjectIdentifier

      public VoidResponse setTermAsObjectIdentifier(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Classify the glossary term to indicate that it describes an object identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • clearTermAsObjectIdentifier

      public VoidResponse clearTermAsObjectIdentifier(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody)
      Remove the object identifier designation from the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • undoGlossaryTermUpdate

      public GlossaryTermElementResponse undoGlossaryTermUpdate(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody)
      Undo the last update to the glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to update
      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)

    • archiveGlossaryTerm

      public VoidResponse archiveGlossaryTerm(String serverName, String glossaryTermGUID, boolean forDuplicateProcessing, ArchiveRequestBody requestBody)
      Archive the metadata element representing a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to archive
      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)

    • removeGlossaryTerm

      public VoidResponse removeGlossaryTerm(String serverName, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody)
      Remove the metadata element representing a glossary term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the metadata element to remove
      forLineage - return elements marked with the Memento classification?
      forDuplicateProcessing - do not merge elements marked as duplicates?
      requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)