GlossaryExchangeRESTServices (Asset Manager OMAS Server-side 2.5 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.assetmanager.server.GlossaryExchangeRESTServices

```
public class GlossaryExchangeRESTServices
extends Object
```
GlossaryExchangeRESTServices is the server-side implementation of the Asset Manager OMAS's support for glossaries. It matches the GlossaryExchangeClient.

Constructor Summary

Constructors
Constructor and Description

GlossaryExchangeRESTServices()
Default constructor

Constructors
Constructor and Description
`GlossaryExchangeRESTServices()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VoidResponse`	`attachExternalCategoryLink(String serverName, String userId, String glossaryCategoryGUID, String externalLinkGUID, ExternalGlossaryElementLinkRequestBody requestBody)` Create a link to an external glossary category resource.
`VoidResponse`	`attachExternalLinkToGlossary(String serverName, String userId, String glossaryGUID, String externalLinkGUID, AssetManagerIdentifiersRequestBody requestBody)` Connect a glossary to a reference to an external glossary resource.
`VoidResponse`	`attachExternalTermLink(String serverName, String userId, String externalLinkGUID, String glossaryTermGUID, ExternalGlossaryElementLinkRequestBody requestBody)` Create a link to an external glossary term resource.
`VoidResponse`	`clearCategoryParent(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, AssetManagerIdentifiersRequestBody requestBody)` Remove a parent-child relationship between two categories.
`VoidResponse`	`clearGlossaryAsCanonical(String serverName, String userId, String glossaryGUID, MetadataCorrelationProperties requestBody)` Remove the canonical designation from the glossary.
`VoidResponse`	`clearGlossaryAsTaxonomy(String serverName, String userId, String glossaryGUID, MetadataCorrelationProperties requestBody)` Remove the taxonomy designation from the glossary.
`VoidResponse`	`clearTermAsAbstractConcept(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the abstract concept designation from the glossary term.
`VoidResponse`	`clearTermAsActivity(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the activity designation from the glossary term.
`VoidResponse`	`clearTermAsContext(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the context definition designation from the glossary term.
`VoidResponse`	`clearTermAsDataValue(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the data value designation from the glossary term.
`VoidResponse`	`clearTermAsObjectIdentifier(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the object identifier designation from the glossary term.
`VoidResponse`	`clearTermAsSpineAttribute(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the spine attribute designation from the glossary term.
`VoidResponse`	`clearTermAsSpineObject(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the spine object designation from the glossary term.
`VoidResponse`	`clearTermCategory(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, AssetManagerIdentifiersRequestBody requestBody)` Unlink a term from a category.
`VoidResponse`	`clearTermRelationship(String serverName, String userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, AssetManagerIdentifiersRequestBody requestBody)` Remove the relationship between two terms.
`GUIDResponse`	`createControlledGlossaryTerm(String serverName, String userId, String glossaryGUID, ControlledGlossaryTermRequestBody requestBody)` Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
`GUIDResponse`	`createExternalGlossaryLink(String serverName, String userId, ExternalGlossaryLinkRequestBody requestBody)` Create a link to an external glossary resource.
`GUIDResponse`	`createGlossary(String serverName, String userId, GlossaryRequestBody requestBody)` Create a new metadata element to represent the root of a glossary.
`GUIDResponse`	`createGlossaryCategory(String serverName, String userId, String glossaryGUID, GlossaryCategoryRequestBody requestBody)` Create a new metadata element to represent a glossary category.
`GUIDResponse`	`createGlossaryCategoryFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)` Create a new metadata element to represent a glossary category using an existing metadata element as a template.
`GUIDResponse`	`createGlossaryFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)` Create a new metadata element to represent a glossary using an existing metadata element as a template.
`GUIDResponse`	`createGlossaryTerm(String serverName, String userId, String glossaryGUID, GlossaryTermRequestBody requestBody)` Create a new metadata element to represent a glossary term.
`GUIDResponse`	`createGlossaryTermFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)` Create a new metadata element to represent a glossary term using an existing metadata element as a template.
`VoidResponse`	`detachExternalCategoryLink(String serverName, String userId, String externalLinkGUID, String glossaryCategoryGUID, AssetManagerIdentifiersRequestBody requestBody)` Remove the link to an external glossary category resource.
`VoidResponse`	`detachExternalLinkFromGlossary(String serverName, String userId, String externalLinkGUID, String glossaryGUID, AssetManagerIdentifiersRequestBody requestBody)` Disconnect a glossary from a reference to an external glossary resource.
`VoidResponse`	`detachExternalTermLink(String serverName, String userId, String externalLinkGUID, String glossaryTermGUID, AssetManagerIdentifiersRequestBody requestBody)` Remove the link to an external glossary term resource.
`GlossaryElementsResponse`	`findGlossaries(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)` Retrieve the list of glossary metadata elements that contain the search string.
`GlossaryCategoryElementsResponse`	`findGlossaryCategories(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)` Retrieve the list of glossary category metadata elements that contain the search string.
`GlossaryTermElementsResponse`	`findGlossaryTerms(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)` Retrieve the list of glossary term metadata elements that contain the search string.
`GlossaryCategoryElementsResponse`	`getCategoriesForGlossary(String serverName, String userId, String glossaryGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Return the list of categories associated with a glossary.
`ExternalGlossaryLinkElementsResponse`	`getExternalLinksForGlossary(String serverName, String userId, String glossaryGUID, int startFrom, int pageSize)` Retrieve the list of links to external glossary resources attached to a glossary.
`GlossaryElementsResponse`	`getGlossariesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)` Retrieve the list of glossary metadata elements with a matching qualified or display name.
`GlossaryElementsResponse`	`getGlossariesForAssetManager(String serverName, String userId, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the list of glossaries created by this caller.
`GlossaryElementsResponse`	`getGlossariesForExternalLink(String serverName, String userId, String externalLinkGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Return the glossaries connected to an external glossary source.
`GlossaryElementResponse`	`getGlossaryByGUID(String serverName, String userId, String openMetadataGUID, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the glossary metadata element with the supplied unique identifier.
`GlossaryCategoryElementsResponse`	`getGlossaryCategoriesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)` Retrieve the list of glossary category metadata elements with a matching qualified or display name.
`GlossaryCategoryElementResponse`	`getGlossaryCategoryByGUID(String serverName, String userId, String glossaryCategoryGUID, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryCategoryElementResponse`	`getGlossaryCategoryParent(String serverName, String userId, String glossaryCategoryGUID, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryCategoryElementsResponse`	`getGlossarySubCategories(String serverName, String userId, String glossaryCategoryGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryTermElementResponse`	`getGlossaryTermByGUID(String serverName, String userId, String guid, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the glossary term metadata element with the supplied unique identifier.
`GlossaryTermElementsResponse`	`getGlossaryTermsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)` Retrieve the list of glossary term metadata elements with a matching qualified or display name.
`GlossaryTermElementsResponse`	`getTermsForGlossary(String serverName, String userId, String glossaryGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the list of glossary terms associated with a glossary.
`GlossaryTermElementsResponse`	`getTermsForGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)` Retrieve the list of glossary terms associated with a glossary category.
`VoidResponse`	`removeExternalGlossaryLink(String serverName, String userId, String externalLinkGUID, AssetManagerIdentifiersRequestBody requestBody)` Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
`VoidResponse`	`removeGlossary(String serverName, String userId, String glossaryGUID, MetadataCorrelationProperties requestBody)` Remove the metadata element representing a glossary.
`VoidResponse`	`removeGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, MetadataCorrelationProperties requestBody)` Remove the metadata element representing a glossary category.
`VoidResponse`	`removeGlossaryTerm(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Remove the metadata element representing a glossary term.
`VoidResponse`	`setGlossaryAsCanonical(String serverName, String userId, String glossaryGUID, CanonicalVocabularyClassificationRequestBody requestBody)` Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.
`VoidResponse`	`setGlossaryAsTaxonomy(String serverName, String userId, String glossaryGUID, TaxonomyClassificationRequestBody requestBody)` Classify the glossary to indicate that it can be used as a taxonomy.
`VoidResponse`	`setTermAsAbstractConcept(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Classify the glossary term to indicate that it describes an abstract concept.
`VoidResponse`	`setTermAsActivity(String serverName, String userId, String glossaryTermGUID, ActivityTermClassificationRequestBody requestBody)` Classify the glossary term to indicate that it describes a data value.
`VoidResponse`	`setTermAsContext(String serverName, String userId, String glossaryTermGUID, ContextDefinitionClassificationRequestBody requestBody)` Classify the glossary term to indicate that it describes a context.
`VoidResponse`	`setTermAsDataValue(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Classify the glossary term to indicate that it describes a data value.
`VoidResponse`	`setTermAsObjectIdentifier(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Classify the glossary term to indicate that it describes an object identifier.
`VoidResponse`	`setTermAsSpineAttribute(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Classify the glossary term to indicate that it describes a spine attribute.
`VoidResponse`	`setTermAsSpineObject(String serverName, String userId, String glossaryTermGUID, MetadataCorrelationProperties requestBody)` Classify the glossary term to indicate that it describes a spine object.
`VoidResponse`	`setupCategoryParent(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, AssetManagerIdentifiersRequestBody requestBody)` Create a parent-child relationship between two categories.
`VoidResponse`	`setupTermCategory(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, CategorizationRequestBody requestBody)` Link a term to a category.
`VoidResponse`	`setupTermRelationship(String serverName, String userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, TermRelationshipRequestBody requestBody)` Link two terms together using a specialist relationship.
`VoidResponse`	`updateExternalGlossaryLink(String serverName, String userId, String externalLinkGUID, ExternalGlossaryLinkRequestBody requestBody)` Update the properties of a reference to an external glossary resource.
`VoidResponse`	`updateGlossary(String serverName, String userId, String glossaryGUID, GlossaryRequestBody requestBody)` Update the metadata element representing a glossary.
`VoidResponse`	`updateGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, GlossaryCategoryRequestBody requestBody)` Update the metadata element representing a glossary category.
`VoidResponse`	`updateGlossaryTerm(String serverName, String userId, String glossaryTermGUID, GlossaryTermRequestBody requestBody)` Update the metadata element representing a glossary term.
`VoidResponse`	`updateGlossaryTermStatus(String serverName, String userId, String glossaryTermGUID, GlossaryTermStatusRequestBody requestBody)` Update the status of the metadata element representing a glossary term.
`VoidResponse`	`updateTermRelationship(String serverName, String userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, TermRelationshipRequestBody requestBody)` Update the relationship properties for the two terms.

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

- Constructor Detail
  - GlossaryExchangeRESTServices
```
public GlossaryExchangeRESTServices()
```
    Default constructor
- Method Detail
  - createGlossary
```
public GUIDResponse createGlossary(String serverName,
                                   String userId,
                                   GlossaryRequestBody 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
    
    userId - calling user
    
    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 userId,
                                               String templateGUID,
                                               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
    
    userId - calling user
    
    templateGUID - unique identifier of the metadata element to copy
    
    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 userId,
                                   String glossaryGUID,
                                   GlossaryRequestBody requestBody)
```
    Update the metadata element representing a glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to update
    
    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 userId,
                                   String glossaryGUID,
                                   MetadataCorrelationProperties 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
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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)
  - setGlossaryAsTaxonomy
```
public VoidResponse setGlossaryAsTaxonomy(String serverName,
                                          String userId,
                                          String glossaryGUID,
                                          TaxonomyClassificationRequestBody 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
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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 userId,
                                            String glossaryGUID,
                                            MetadataCorrelationProperties requestBody)
```
    Remove the taxonomy designation from the glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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 userId,
                                           String glossaryGUID,
                                           CanonicalVocabularyClassificationRequestBody 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
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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 userId,
                                             String glossaryGUID,
                                             MetadataCorrelationProperties requestBody)
```
    Remove the canonical designation from the glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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)
  - findGlossaries
```
public GlossaryElementsResponse findGlossaries(String serverName,
                                               String userId,
                                               int startFrom,
                                               int pageSize,
                                               SearchStringRequestBody requestBody)
```
    Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    requestBody - string to find in the properties
    
    startFrom - paging start point
    
    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)
  - getGlossariesByName
```
public GlossaryElementsResponse getGlossariesByName(String serverName,
                                                    String userId,
                                                    int startFrom,
                                                    int pageSize,
                                                    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
    
    userId - calling user
    
    requestBody - name to search for
    
    startFrom - paging start point
    
    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)
  - getGlossariesForAssetManager
```
public GlossaryElementsResponse getGlossariesForAssetManager(String serverName,
                                                             String userId,
                                                             int startFrom,
                                                             int pageSize,
                                                             AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the list of glossaries created by this caller.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers
    
    Returns:
    
    list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossaryByGUID
```
public GlossaryElementResponse getGlossaryByGUID(String serverName,
                                                 String userId,
                                                 String openMetadataGUID,
                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the glossary metadata element with the supplied unique identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    openMetadataGUID - unique identifier of the requested metadata element
    
    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)
  - createGlossaryCategory
```
public GUIDResponse createGlossaryCategory(String serverName,
                                           String userId,
                                           String glossaryGUID,
                                           GlossaryCategoryRequestBody requestBody)
```
    Create a new metadata element to represent a glossary category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the glossary where the category is located
    
    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 userId,
                                                       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
    
    userId - calling user
    
    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 userId,
                                           String glossaryCategoryGUID,
                                           GlossaryCategoryRequestBody requestBody)
```
    Update the metadata element representing a glossary category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the metadata element to update
    
    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 userId,
                                        String glossaryParentCategoryGUID,
                                        String glossaryChildCategoryGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)
```
    Create a parent-child relationship between two categories.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    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
    
    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 userId,
                                        String glossaryParentCategoryGUID,
                                        String glossaryChildCategoryGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)
```
    Remove a parent-child relationship between two categories.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    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
    
    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 userId,
                                           String glossaryCategoryGUID,
                                           MetadataCorrelationProperties requestBody)
```
    Remove the metadata element representing a glossary category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the metadata element to remove
    
    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)
  - findGlossaryCategories
```
public GlossaryCategoryElementsResponse findGlossaryCategories(String serverName,
                                                               String userId,
                                                               int startFrom,
                                                               int pageSize,
                                                               SearchStringRequestBody requestBody)
```
    Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - string to find in the properties and correlators
    
    Returns:
    
    list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getCategoriesForGlossary
```
public GlossaryCategoryElementsResponse getCategoriesForGlossary(String serverName,
                                                                 String userId,
                                                                 String glossaryGUID,
                                                                 int startFrom,
                                                                 int pageSize,
                                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Return the list of categories associated with a glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the glossary to query
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers
    
    Returns:
    
    list of metadata elements describing the categories associated with the requested glossary or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossaryCategoriesByName
```
public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(String serverName,
                                                                    String userId,
                                                                    int startFrom,
                                                                    int pageSize,
                                                                    NameRequestBody 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
    
    userId - calling user
    
    requestBody - name to search for and correlators
    
    startFrom - paging start point
    
    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)
  - getGlossaryCategoryByGUID
```
public GlossaryCategoryElementResponse getGlossaryCategoryByGUID(String serverName,
                                                                 String userId,
                                                                 String glossaryCategoryGUID,
                                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the glossary category metadata element with the supplied unique identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the requested metadata element
    
    requestBody - asset manager identifiers
    
    Returns:
    
    requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossaryCategoryParent
```
public GlossaryCategoryElementResponse getGlossaryCategoryParent(String serverName,
                                                                 String userId,
                                                                 String glossaryCategoryGUID,
                                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the glossary category metadata element with the supplied unique identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the requested metadata element
    
    requestBody - asset manager identifiers
    
    Returns:
    
    parent glossary category element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossarySubCategories
```
public GlossaryCategoryElementsResponse getGlossarySubCategories(String serverName,
                                                                 String userId,
                                                                 String glossaryCategoryGUID,
                                                                 int startFrom,
                                                                 int pageSize,
                                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the glossary category metadata element with the supplied unique identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the requested metadata element
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    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)
  - createGlossaryTerm
```
public GUIDResponse createGlossaryTerm(String serverName,
                                       String userId,
                                       String glossaryGUID,
                                       GlossaryTermRequestBody requestBody)
```
    Create a new metadata element to represent a glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the glossary where the term is located
    
    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)
  - createControlledGlossaryTerm
```
public GUIDResponse createControlledGlossaryTerm(String serverName,
                                                 String userId,
                                                 String glossaryGUID,
                                                 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
    
    userId - calling user
    
    glossaryGUID - unique identifier of the glossary where the term is located
    
    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 userId,
                                                   String templateGUID,
                                                   TemplateRequestBody 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
    
    userId - calling user
    
    templateGUID - unique identifier of the metadata element to copy
    
    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 userId,
                                       String glossaryTermGUID,
                                       GlossaryTermRequestBody requestBody)
```
    Update the metadata element representing a glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the glossary term to update
    
    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 userId,
                                             String glossaryTermGUID,
                                             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
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the glossary term to update
    
    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 userId,
                                      String glossaryCategoryGUID,
                                      String glossaryTermGUID,
                                      CategorizationRequestBody requestBody)
```
    Link a term to a category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the glossary category
    
    glossaryTermGUID - unique identifier of the glossary term
    
    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 userId,
                                      String glossaryCategoryGUID,
                                      String glossaryTermGUID,
                                      AssetManagerIdentifiersRequestBody requestBody)
```
    Unlink a term from a category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the glossary category
    
    glossaryTermGUID - unique identifier of the glossary term
    
    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)
  - setupTermRelationship
```
public VoidResponse setupTermRelationship(String serverName,
                                          String userId,
                                          String glossaryTermOneGUID,
                                          String relationshipTypeName,
                                          String glossaryTermTwoGUID,
                                          TermRelationshipRequestBody requestBody)
```
    Link two terms together using a specialist relationship.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    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
    
    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 userId,
                                           String glossaryTermOneGUID,
                                           String relationshipTypeName,
                                           String glossaryTermTwoGUID,
                                           TermRelationshipRequestBody requestBody)
```
    Update the relationship properties for the two terms.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    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
    
    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 userId,
                                          String glossaryTermOneGUID,
                                          String relationshipTypeName,
                                          String glossaryTermTwoGUID,
                                          AssetManagerIdentifiersRequestBody requestBody)
```
    Remove the relationship between two terms.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    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
    
    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 userId,
                                             String glossaryTermGUID,
                                             MetadataCorrelationProperties requestBody)
```
    Classify the glossary term to indicate that it describes an abstract concept.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                               String glossaryTermGUID,
                                               MetadataCorrelationProperties requestBody)
```
    Remove the abstract concept designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                       String glossaryTermGUID,
                                       MetadataCorrelationProperties requestBody)
```
    Classify the glossary term to indicate that it describes a data value.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                         String glossaryTermGUID,
                                         MetadataCorrelationProperties requestBody)
```
    Remove the data value designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                      String glossaryTermGUID,
                                      ActivityTermClassificationRequestBody requestBody)
```
    Classify the glossary term to indicate that it describes a data value.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                        String glossaryTermGUID,
                                        MetadataCorrelationProperties requestBody)
```
    Remove the activity designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                     String glossaryTermGUID,
                                     ContextDefinitionClassificationRequestBody requestBody)
```
    Classify the glossary term to indicate that it describes a context.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                       String glossaryTermGUID,
                                       MetadataCorrelationProperties requestBody)
```
    Remove the context definition designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                         String glossaryTermGUID,
                                         MetadataCorrelationProperties requestBody)
```
    Classify the glossary term to indicate that it describes a spine object.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                           String glossaryTermGUID,
                                           MetadataCorrelationProperties requestBody)
```
    Remove the spine object designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                            String glossaryTermGUID,
                                            MetadataCorrelationProperties requestBody)
```
    Classify the glossary term to indicate that it describes a spine attribute.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                              String glossaryTermGUID,
                                              MetadataCorrelationProperties requestBody)
```
    Remove the spine attribute designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                              String glossaryTermGUID,
                                              MetadataCorrelationProperties requestBody)
```
    Classify the glossary term to indicate that it describes an object identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                                String glossaryTermGUID,
                                                MetadataCorrelationProperties requestBody)
```
    Remove the object identifier designation from the glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to update
    
    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 userId,
                                       String glossaryTermGUID,
                                       MetadataCorrelationProperties requestBody)
```
    Remove the metadata element representing a glossary term.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryTermGUID - unique identifier of the metadata element to remove
    
    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)
  - findGlossaryTerms
```
public GlossaryTermElementsResponse findGlossaryTerms(String serverName,
                                                      String userId,
                                                      int startFrom,
                                                      int pageSize,
                                                      SearchStringRequestBody 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
    
    userId - calling user
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers and search string
    
    Returns:
    
    list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getTermsForGlossary
```
public GlossaryTermElementsResponse getTermsForGlossary(String serverName,
                                                        String userId,
                                                        String glossaryGUID,
                                                        int startFrom,
                                                        int pageSize,
                                                        AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the list of glossary terms associated with a glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the glossary of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers
    
    Returns:
    
    list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getTermsForGlossaryCategory
```
public GlossaryTermElementsResponse getTermsForGlossaryCategory(String serverName,
                                                                String userId,
                                                                String glossaryCategoryGUID,
                                                                int startFrom,
                                                                int pageSize,
                                                                AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the list of glossary terms associated with a glossary category.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryCategoryGUID - unique identifier of the glossary category of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers
    
    Returns:
    
    list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossaryTermsByName
```
public GlossaryTermElementsResponse getGlossaryTermsByName(String serverName,
                                                           String userId,
                                                           int startFrom,
                                                           int pageSize,
                                                           NameRequestBody 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
    
    userId - calling user
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers and name
    
    Returns:
    
    list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
  - getGlossaryTermByGUID
```
public GlossaryTermElementResponse getGlossaryTermByGUID(String serverName,
                                                         String userId,
                                                         String guid,
                                                         AssetManagerIdentifiersRequestBody requestBody)
```
    Retrieve the glossary term metadata element with the supplied unique identifier.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    guid - unique identifier of the requested metadata element
    
    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)
  - createExternalGlossaryLink
```
public GUIDResponse createExternalGlossaryLink(String serverName,
                                               String userId,
                                               ExternalGlossaryLinkRequestBody requestBody)
```
    Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    requestBody - properties of the link
    
    Returns:
    
    unique identifier of the external reference 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)
  - updateExternalGlossaryLink
```
public VoidResponse updateExternalGlossaryLink(String serverName,
                                               String userId,
                                               String externalLinkGUID,
                                               ExternalGlossaryLinkRequestBody requestBody)
```
    Update the properties of a reference to an external glossary resource.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    requestBody - properties of the link
    
    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)
  - removeExternalGlossaryLink
```
public VoidResponse removeExternalGlossaryLink(String serverName,
                                               String userId,
                                               String externalLinkGUID,
                                               AssetManagerIdentifiersRequestBody requestBody)
```
    Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    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)
  - attachExternalLinkToGlossary
```
public VoidResponse attachExternalLinkToGlossary(String serverName,
                                                 String userId,
                                                 String glossaryGUID,
                                                 String externalLinkGUID,
                                                 AssetManagerIdentifiersRequestBody requestBody)
```
    Connect a glossary to a reference to an external glossary resource.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryGUID - unique identifier of the metadata element to attach
    
    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)
  - detachExternalLinkFromGlossary
```
public VoidResponse detachExternalLinkFromGlossary(String serverName,
                                                   String userId,
                                                   String externalLinkGUID,
                                                   String glossaryGUID,
                                                   AssetManagerIdentifiersRequestBody requestBody)
```
    Disconnect a glossary from a reference to an external glossary resource.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryGUID - unique identifier of the metadata element to remove
    
    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)
  - getExternalLinksForGlossary
```
public ExternalGlossaryLinkElementsResponse getExternalLinksForGlossary(String serverName,
                                                                        String userId,
                                                                        String glossaryGUID,
                                                                        int startFrom,
                                                                        int pageSize)
```
    Retrieve the list of links to external glossary resources attached to a glossary.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    glossaryGUID - unique identifier of the metadata element for the glossary of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    Returns:
    
    list of attached links to external glossary resources 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)
  - getGlossariesForExternalLink
```
public GlossaryElementsResponse getGlossariesForExternalLink(String serverName,
                                                             String userId,
                                                             String externalLinkGUID,
                                                             int startFrom,
                                                             int pageSize,
                                                             AssetManagerIdentifiersRequestBody requestBody)
```
    Return the glossaries connected to an external glossary source.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the metadata element for the external glossary link of interest
    
    startFrom - paging start point
    
    pageSize - maximum results that can be returned
    
    requestBody - asset manager identifiers
    
    Returns:
    
    list of glossaries 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)
  - attachExternalCategoryLink
```
public VoidResponse attachExternalCategoryLink(String serverName,
                                               String userId,
                                               String glossaryCategoryGUID,
                                               String externalLinkGUID,
                                               ExternalGlossaryElementLinkRequestBody requestBody)
```
    Create a link to an external glossary category resource. This is associated with a category to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryCategoryGUID - unique identifier for the the glossary category
    
    requestBody - properties of the link
    
    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)
  - detachExternalCategoryLink
```
public VoidResponse detachExternalCategoryLink(String serverName,
                                               String userId,
                                               String externalLinkGUID,
                                               String glossaryCategoryGUID,
                                               AssetManagerIdentifiersRequestBody requestBody)
```
    Remove the link to an external glossary category resource.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryCategoryGUID - unique identifier for the the glossary category
    
    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)
  - attachExternalTermLink
```
public VoidResponse attachExternalTermLink(String serverName,
                                           String userId,
                                           String externalLinkGUID,
                                           String glossaryTermGUID,
                                           ExternalGlossaryElementLinkRequestBody requestBody)
```
    Create a link to an external glossary term resource. This is associated with a term to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryTermGUID - unique identifier for the the glossary category
    
    requestBody - properties of the link
    
    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)
  - detachExternalTermLink
```
public VoidResponse detachExternalTermLink(String serverName,
                                           String userId,
                                           String externalLinkGUID,
                                           String glossaryTermGUID,
                                           AssetManagerIdentifiersRequestBody requestBody)
```
    Remove the link to an external glossary term resource.
    
    Parameters:
    
    serverName - name of the server to route the request to
    
    userId - calling user
    
    externalLinkGUID - unique identifier of the external reference
    
    glossaryTermGUID - unique identifier for the the glossary category
    
    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)

Class GlossaryExchangeRESTServices

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryExchangeRESTServices

Method Detail

createGlossary

createGlossaryFromTemplate

updateGlossary

removeGlossary

setGlossaryAsTaxonomy

clearGlossaryAsTaxonomy

setGlossaryAsCanonical

clearGlossaryAsCanonical

findGlossaries

getGlossariesByName

getGlossariesForAssetManager

getGlossaryByGUID

createGlossaryCategory

createGlossaryCategoryFromTemplate

updateGlossaryCategory

setupCategoryParent

clearCategoryParent

removeGlossaryCategory

findGlossaryCategories

getCategoriesForGlossary

getGlossaryCategoriesByName

getGlossaryCategoryByGUID

getGlossaryCategoryParent

getGlossarySubCategories

createGlossaryTerm

createControlledGlossaryTerm

createGlossaryTermFromTemplate

updateGlossaryTerm

updateGlossaryTermStatus

setupTermCategory

clearTermCategory

setupTermRelationship

updateTermRelationship

clearTermRelationship

setTermAsAbstractConcept

clearTermAsAbstractConcept

setTermAsDataValue

clearTermAsDataValue

setTermAsActivity

clearTermAsActivity

setTermAsContext

clearTermAsContext

setTermAsSpineObject

clearTermAsSpineObject

setTermAsSpineAttribute

clearTermAsSpineAttribute

setTermAsObjectIdentifier

clearTermAsObjectIdentifier

removeGlossaryTerm

findGlossaryTerms

getTermsForGlossary

getTermsForGlossaryCategory

getGlossaryTermsByName

getGlossaryTermByGUID

createExternalGlossaryLink

updateExternalGlossaryLink

removeExternalGlossaryLink

attachExternalLinkToGlossary

detachExternalLinkFromGlossary

getExternalLinksForGlossary

getGlossariesForExternalLink

attachExternalCategoryLink

detachExternalCategoryLink

attachExternalTermLink

detachExternalTermLink