```
public interface GlossaryExchangeInterface
```
GlossaryExchangeInterface defines the client side interface for the Asset Manager OMAS that is relevant for managing glossaries. It provides the ability to define and maintain the content of glossary as well as govern it. Glossaries have a top-level root object that describe the purpose, language and intended usage of its content. Linked to the glossary's root object are the terms, categories and relationships it contains. In addition to the content, the glossary can be augmented with classifications and linked to external glossary definitions.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`attachExternalCategoryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryCategoryGUID, ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Create a link to an external glossary category resource.
`void`	`attachExternalLinkToGlossary(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Connect a glossary to a reference to an external glossary resource.
`void`	`attachExternalTermLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryTermGUID, ExternalGlossaryElementLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Create a link to an external glossary term resource.
`void`	`clearCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove a parent-child relationship between two categories.
`void`	`clearGlossaryAsCanonical(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the canonical designation from the glossary.
`void`	`clearGlossaryAsTaxonomy(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the taxonomy designation from the glossary.
`void`	`clearTermAsAbstractConcept(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the abstract concept designation from the glossary term.
`void`	`clearTermAsActivity(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the activity designation from the glossary term.
`void`	`clearTermAsContext(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the context definition designation from the glossary term.
`void`	`clearTermAsDataValue(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the data value designation from the glossary term.
`void`	`clearTermAsObjectIdentifier(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the object identifier designation from the glossary term.
`void`	`clearTermAsSpineAttribute(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the spine attribute designation from the glossary term.
`void`	`clearTermAsSpineObject(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the spine object designation from the glossary term.
`void`	`clearTermCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Unlink a term from a category.
`void`	`clearTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the relationship between two terms.
`String`	`createControlledGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryTermProperties glossaryTermProperties, GlossaryTermStatus initialStatus)`	Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.
`String`	`createExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, ExternalGlossaryLinkProperties linkProperties)`	Create a link to an external glossary resource.
`String`	`createGlossary(String userId, String assetManagerGUID, String assetManagerName, ExternalIdentifierProperties externalIdentifierProperties, GlossaryProperties glossaryProperties)`	Create a new metadata element to represent the root of a glossary.
`String`	`createGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryCategoryProperties glossaryCategoryProperties)`	Create a new metadata element to represent a glossary category.
`String`	`createGlossaryCategoryFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary category using an existing metadata element as a template.
`String`	`createGlossaryFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary using an existing metadata element as a template.
`String`	`createGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, ExternalIdentifierProperties externalIdentifierProperties, GlossaryTermProperties glossaryTermProperties)`	Create a new metadata element to represent a glossary term.
`String`	`createGlossaryTermFromTemplate(String userId, String assetManagerGUID, String assetManagerName, String templateGUID, ExternalIdentifierProperties externalIdentifierProperties, TemplateProperties templateProperties)`	Create a new metadata element to represent a glossary term using an existing metadata element as a template.
`void`	`detachExternalCategoryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the link to an external glossary category resource.
`void`	`detachExternalLinkFromGlossary(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Disconnect a glossary from a reference to an external glossary resource.
`void`	`detachExternalTermLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the link to an external glossary term resource.
`List<GlossaryElement>`	`findGlossaries(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize)`	Retrieve the list of glossary metadata elements that contain the search string.
`List<GlossaryCategoryElement>`	`findGlossaryCategories(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary category metadata elements that contain the search string.
`List<GlossaryTermElement>`	`findGlossaryTerms(String userId, String assetManagerGUID, String assetManagerName, String searchString, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary term metadata elements that contain the search string.
`List<GlossaryCategoryElement>`	`getCategoriesForGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Return the list of categories associated with a glossary.
`List<ExternalGlossaryLinkElement>`	`getExternalLinksForGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of links to external glossary resources attached to a glossary.
`List<GlossaryElement>`	`getGlossariesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize)`	Retrieve the list of glossary metadata elements with a matching qualified or display name.
`List<GlossaryElement>`	`getGlossariesForAssetManager(String userId, String assetManagerGUID, String assetManagerName, int startFrom, int pageSize)`	Retrieve the list of glossaries created on behalf of the named asset manager.
`List<GlossaryElement>`	`getGlossariesForExternalLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Return the glossaries connected to an external glossary source.
`GlossaryElement`	`getGlossaryByGUID(String userId, String assetManagerGUID, String assetManagerName, String openMetadataGUID)`	Retrieve the glossary metadata element with the supplied unique identifier.
`List<GlossaryCategoryElement>`	`getGlossaryCategoriesByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary category metadata elements with a matching qualified or display name.
`GlossaryCategoryElement`	`getGlossaryCategoryByGUID(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryCategoryElement`	`getGlossaryCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`List<GlossaryCategoryElement>`	`getGlossarySubCategories(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the glossary category metadata element with the supplied unique identifier.
`GlossaryTermElement`	`getGlossaryTermByGUID(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the glossary term metadata element with the supplied unique identifier.
`List<GlossaryTermElement>`	`getGlossaryTermsByName(String userId, String assetManagerGUID, String assetManagerName, String name, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary term metadata elements with a matching qualified or display name.
`List<GlossaryTermElement>`	`getTermsForGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary terms associated with a glossary.
`List<GlossaryTermElement>`	`getTermsForGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, int startFrom, int pageSize, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Retrieve the list of glossary terms associated with a glossary category.
`void`	`removeExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).
`void`	`removeGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier)`	Remove the metadata element representing a glossary.
`void`	`removeGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the metadata element representing a glossary category.
`void`	`removeGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Remove the metadata element representing a glossary term.
`void`	`setGlossaryAsCanonical(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, String scope)`	Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.
`void`	`setGlossaryAsTaxonomy(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, String organizingPrinciple)`	Classify the glossary to indicate that it can be used as a taxonomy.
`void`	`setTermAsAbstractConcept(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes an abstract concept.
`void`	`setTermAsActivity(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermActivityType activityType, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes a data value.
`void`	`setTermAsContext(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermContextDefinition contextDefinition, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes a context.
`void`	`setTermAsDataValue(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes a data value.
`void`	`setTermAsObjectIdentifier(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes an object identifier.
`void`	`setTermAsSpineAttribute(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes a spine attribute.
`void`	`setTermAsSpineObject(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Classify the glossary term to indicate that it describes a spine object.
`void`	`setupCategoryParent(String userId, String assetManagerGUID, String assetManagerName, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Create a parent-child relationship between two categories.
`void`	`setupTermCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryTermGUID, GlossaryTermCategorization categorizationProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Link a term to a category.
`void`	`setupTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Link two terms together using a specialist relationship.
`void`	`updateExternalGlossaryLink(String userId, String assetManagerGUID, String assetManagerName, String externalLinkGUID, boolean isMergeUpdate, ExternalGlossaryLinkProperties linkProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Update the properties of a reference to an external glossary resource.
`void`	`updateGlossary(String userId, String assetManagerGUID, String assetManagerName, String glossaryGUID, String glossaryExternalIdentifier, GlossaryProperties glossaryProperties)`	Update the metadata element representing a glossary.
`void`	`updateGlossaryCategory(String userId, String assetManagerGUID, String assetManagerName, String glossaryCategoryGUID, String glossaryCategoryExternalIdentifier, boolean isMergeUpdate, GlossaryCategoryProperties glossaryCategoryProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Update the metadata element representing a glossary category.
`void`	`updateGlossaryTerm(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, boolean isMergeUpdate, GlossaryTermProperties glossaryTermProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Update the properties of the metadata element representing a glossary term.
`void`	`updateGlossaryTermStatus(String userId, String assetManagerGUID, String assetManagerName, String glossaryTermGUID, String glossaryTermExternalIdentifier, GlossaryTermStatus glossaryTermStatus, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Update the status of the metadata element representing a glossary term.
`void`	`updateTermRelationship(String userId, String assetManagerGUID, String assetManagerName, String relationshipTypeName, String glossaryTermOneGUID, String glossaryTermTwoGUID, GlossaryTermRelationship relationshipsProperties, Date effectiveTime, boolean forLineage, boolean forDuplicateProcessing)`	Update the relationship properties for the two terms.

Method Detail

createGlossary
```
String createGlossary(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      ExternalIdentifierProperties externalIdentifierProperties,
                      GlossaryProperties glossaryProperties)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalIdentifierProperties - optional properties used to define an external identifier

glossaryProperties - properties to store

Returns:

unique identifier of the new metadata element

Throws:

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
```
String createGlossaryFromTemplate(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String templateGUID,
                                  ExternalIdentifierProperties externalIdentifierProperties,
                                  TemplateProperties templateProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalIdentifierProperties - optional properties used to define an external identifier

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new metadata element

Throws:

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
```
void updateGlossary(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String glossaryGUID,
                    String glossaryExternalIdentifier,
                    GlossaryProperties glossaryProperties)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException
```
Update the metadata element representing a glossary.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to update

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

glossaryProperties - new properties for this element

Throws:

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
```
void setGlossaryAsTaxonomy(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String glossaryGUID,
                           String glossaryExternalIdentifier,
                           String organizingPrinciple)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to classify

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

organizingPrinciple - description of how the glossary is organized

Throws:

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
```
void clearGlossaryAsTaxonomy(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String glossaryGUID,
                             String glossaryExternalIdentifier)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
Remove the taxonomy designation from the glossary.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to unclassify

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

Throws:

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
```
void setGlossaryAsCanonical(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String glossaryGUID,
                            String glossaryExternalIdentifier,
                            String scope)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to classify

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

scope - description of the situations where this glossary is relevant.

Throws:

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
```
void clearGlossaryAsCanonical(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryGUID,
                              String glossaryExternalIdentifier)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Remove the canonical designation from the glossary.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to unclassify

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

Throws:

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
```
void removeGlossary(String userId,
                    String assetManagerGUID,
                    String assetManagerName,
                    String glossaryGUID,
                    String glossaryExternalIdentifier)
             throws InvalidParameterException,
                    UserNotAuthorizedException,
                    PropertyServerException
```
Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the metadata element to remove

glossaryExternalIdentifier - unique identifier of the glossary in the external asset manager

Throws:

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

List<GlossaryElement> findGlossaries(String userId,
                                     String assetManagerGUID,
                                     String assetManagerName,
                                     String searchString,
                                     int startFrom,
                                     int pageSize)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException

Retrieve the list of glossary metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: 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

List<GlossaryElement> getGlossariesByName(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String name,
                                          int startFrom,
                                          int pageSize)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements
Throws:: 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

List<GlossaryElement> getGlossariesForAssetManager(String userId,
                                                   String assetManagerGUID,
                                                   String assetManagerName,
                                                   int startFrom,
                                                   int pageSize)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Retrieve the list of glossaries created on behalf of the named asset manager.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; startFrom - paging start point; pageSize - maximum results that can be returned *
Returns:: list of matching metadata elements
Throws:: 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
```
GlossaryElement getGlossaryByGUID(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String openMetadataGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
Retrieve the glossary metadata element with the supplied unique identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

openMetadataGUID - unique identifier of the requested metadata element

Returns:

matching metadata element

Throws:

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
```
String createGlossaryCategory(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryGUID,
                              ExternalIdentifierProperties externalIdentifierProperties,
                              GlossaryCategoryProperties glossaryCategoryProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Create a new metadata element to represent a glossary category.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary where the category is located

externalIdentifierProperties - optional properties used to define an external identifier

glossaryCategoryProperties - properties about the glossary category to store

Returns:

unique identifier of the new glossary category

Throws:

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

String createGlossaryCategoryFromTemplate(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String templateGUID,
                                          ExternalIdentifierProperties externalIdentifierProperties,
                                          TemplateProperties templateProperties)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

Create a new metadata element to represent a glossary category using an existing metadata element as a template.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; templateGUID - unique identifier of the metadata element to copy; externalIdentifierProperties - optional properties used to define an external identifier; templateProperties - properties that override the template
Returns:: unique identifier of the new glossary category
Throws:: 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
```
void updateGlossaryCategory(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String glossaryCategoryGUID,
                            String glossaryCategoryExternalIdentifier,
                            boolean isMergeUpdate,
                            GlossaryCategoryProperties glossaryCategoryProperties,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
Update the metadata element representing a glossary category.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the metadata element to update

glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

glossaryCategoryProperties - new properties for the metadata element

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setupCategoryParent(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String glossaryParentCategoryGUID,
                         String glossaryChildCategoryGUID,
                         Date effectiveTime,
                         boolean forLineage,
                         boolean forDuplicateProcessing)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
Create a parent-child relationship between two categories.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearCategoryParent(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String glossaryParentCategoryGUID,
                         String glossaryChildCategoryGUID,
                         Date effectiveTime,
                         boolean forLineage,
                         boolean forDuplicateProcessing)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
Remove a parent-child relationship between two categories.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void removeGlossaryCategory(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String glossaryCategoryGUID,
                            String glossaryCategoryExternalIdentifier,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
Remove the metadata element representing a glossary category.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the metadata element to remove

glossaryCategoryExternalIdentifier - unique identifier of the glossary category in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

List<GlossaryCategoryElement> findGlossaryCategories(String userId,
                                                     String assetManagerGUID,
                                                     String assetManagerName,
                                                     String searchString,
                                                     int startFrom,
                                                     int pageSize,
                                                     Date effectiveTime,
                                                     boolean forLineage,
                                                     boolean forDuplicateProcessing)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Retrieve the list of glossary category metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of matching metadata elements
Throws:: 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

List<GlossaryCategoryElement> getCategoriesForGlossary(String userId,
                                                       String assetManagerGUID,
                                                       String assetManagerName,
                                                       String glossaryGUID,
                                                       int startFrom,
                                                       int pageSize,
                                                       Date effectiveTime,
                                                       boolean forLineage,
                                                       boolean forDuplicateProcessing)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

Return the list of categories associated with a glossary.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryGUID - unique identifier of the glossary to query; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of metadata elements describing the categories associated with the requested glossary
Throws:: 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

List<GlossaryCategoryElement> getGlossaryCategoriesByName(String userId,
                                                          String assetManagerGUID,
                                                          String assetManagerName,
                                                          String name,
                                                          int startFrom,
                                                          int pageSize,
                                                          Date effectiveTime,
                                                          boolean forLineage,
                                                          boolean forDuplicateProcessing)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Retrieve the list of glossary category metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of matching metadata elements
Throws:: 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

GlossaryCategoryElement getGlossaryCategoryByGUID(String userId,
                                                  String assetManagerGUID,
                                                  String assetManagerName,
                                                  String glossaryCategoryGUID,
                                                  Date effectiveTime,
                                                  boolean forLineage,
                                                  boolean forDuplicateProcessing)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: requested metadata element
Throws:: 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

GlossaryCategoryElement getGlossaryCategoryParent(String userId,
                                                  String assetManagerGUID,
                                                  String assetManagerName,
                                                  String glossaryCategoryGUID,
                                                  Date effectiveTime,
                                                  boolean forLineage,
                                                  boolean forDuplicateProcessing)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

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

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: parent glossary category element
Throws:: 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)

getGlossarySubCategories

List<GlossaryCategoryElement> getGlossarySubCategories(String userId,
                                                       String assetManagerGUID,
                                                       String assetManagerName,
                                                       String glossaryCategoryGUID,
                                                       int startFrom,
                                                       int pageSize,
                                                       Date effectiveTime,
                                                       boolean forLineage,
                                                       boolean forDuplicateProcessing)
                                                throws InvalidParameterException,
                                                       UserNotAuthorizedException,
                                                       PropertyServerException

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

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryCategoryGUID - unique identifier of the requested metadata element; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of glossary category element
Throws:: 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)

createGlossaryTerm
```
String createGlossaryTerm(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          String glossaryGUID,
                          ExternalIdentifierProperties externalIdentifierProperties,
                          GlossaryTermProperties glossaryTermProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
Create a new metadata element to represent a glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryGUID - unique identifier of the glossary where the term is located

externalIdentifierProperties - optional properties used to define an external identifier

glossaryTermProperties - properties for the glossary term

Returns:

unique identifier of the new metadata element for the glossary term

Throws:

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

String createControlledGlossaryTerm(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String glossaryGUID,
                                    ExternalIdentifierProperties externalIdentifierProperties,
                                    GlossaryTermProperties glossaryTermProperties,
                                    GlossaryTermStatus initialStatus)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryGUID - unique identifier of the glossary where the term is located; externalIdentifierProperties - optional properties used to define an external identifier; glossaryTermProperties - properties for the glossary term; initialStatus - glossary term status to use when the object is created
Returns:: unique identifier of the new metadata element for the glossary term
Throws:: 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

String createGlossaryTermFromTemplate(String userId,
                                      String assetManagerGUID,
                                      String assetManagerName,
                                      String templateGUID,
                                      ExternalIdentifierProperties externalIdentifierProperties,
                                      TemplateProperties templateProperties)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException

Create a new metadata element to represent a glossary term using an existing metadata element as a template.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; templateGUID - unique identifier of the metadata element to copy; externalIdentifierProperties - optional properties used to define an external identifier; templateProperties - properties that override the template
Returns:: unique identifier of the new metadata element for the glossary term
Throws:: 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
```
void updateGlossaryTerm(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String glossaryTermGUID,
                        String glossaryTermExternalIdentifier,
                        boolean isMergeUpdate,
                        GlossaryTermProperties glossaryTermProperties,
                        Date effectiveTime,
                        boolean forLineage,
                        boolean forDuplicateProcessing)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
Update the properties of the metadata element representing a glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the glossary term to update

isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?

glossaryTermProperties - new properties for the glossary term

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void updateGlossaryTermStatus(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryTermGUID,
                              String glossaryTermExternalIdentifier,
                              GlossaryTermStatus glossaryTermStatus,
                              Date effectiveTime,
                              boolean forLineage,
                              boolean forDuplicateProcessing)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the glossary term to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

glossaryTermStatus - new properties for the glossary term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setupTermCategory(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String glossaryCategoryGUID,
                       String glossaryTermGUID,
                       GlossaryTermCategorization categorizationProperties,
                       Date effectiveTime,
                       boolean forLineage,
                       boolean forDuplicateProcessing)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException
```
Link a term to a category.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category

glossaryTermGUID - unique identifier of the glossary term

categorizationProperties - properties for the categorization relationship

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermCategory(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String glossaryCategoryGUID,
                       String glossaryTermGUID,
                       Date effectiveTime,
                       boolean forLineage,
                       boolean forDuplicateProcessing)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException
```
Unlink a term from a category.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryCategoryGUID - unique identifier of the glossary category

glossaryTermGUID - unique identifier of the glossary term

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

void setupTermRelationship(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String relationshipTypeName,
                           String glossaryTermOneGUID,
                           String glossaryTermTwoGUID,
                           GlossaryTermRelationship relationshipsProperties,
                           Date effectiveTime,
                           boolean forLineage,
                           boolean forDuplicateProcessing)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Link two terms together using a specialist relationship.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; 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; relationshipsProperties - properties related to the new relationship; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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

void updateTermRelationship(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String relationshipTypeName,
                            String glossaryTermOneGUID,
                            String glossaryTermTwoGUID,
                            GlossaryTermRelationship relationshipsProperties,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Update the relationship properties for the two terms.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; 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; relationshipsProperties - properties for the relationship; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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
```
void clearTermRelationship(String userId,
                           String assetManagerGUID,
                           String assetManagerName,
                           String relationshipTypeName,
                           String glossaryTermOneGUID,
                           String glossaryTermTwoGUID,
                           Date effectiveTime,
                           boolean forLineage,
                           boolean forDuplicateProcessing)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException
```
Remove the relationship between two terms.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

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

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsAbstractConcept(String userId,
                              String assetManagerGUID,
                              String assetManagerName,
                              String glossaryTermGUID,
                              String glossaryTermExternalIdentifier,
                              Date effectiveTime,
                              boolean forLineage,
                              boolean forDuplicateProcessing)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
```
Classify the glossary term to indicate that it describes an abstract concept.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

void clearTermAsAbstractConcept(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String glossaryTermGUID,
                                String glossaryTermExternalIdentifier,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the abstract concept designation from the glossary term.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryTermGUID - unique identifier of the metadata element to update; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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
```
void setTermAsDataValue(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String glossaryTermGUID,
                        String glossaryTermExternalIdentifier,
                        Date effectiveTime,
                        boolean forLineage,
                        boolean forDuplicateProcessing)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
Classify the glossary term to indicate that it describes a data value.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermAsDataValue(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          String glossaryTermGUID,
                          String glossaryTermExternalIdentifier,
                          Date effectiveTime,
                          boolean forLineage,
                          boolean forDuplicateProcessing)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
Remove the data value designation from the glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsActivity(String userId,
                       String assetManagerGUID,
                       String assetManagerName,
                       String glossaryTermGUID,
                       String glossaryTermExternalIdentifier,
                       GlossaryTermActivityType activityType,
                       Date effectiveTime,
                       boolean forLineage,
                       boolean forDuplicateProcessing)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException
```
Classify the glossary term to indicate that it describes a data value.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

activityType - type of activity

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermAsActivity(String userId,
                         String assetManagerGUID,
                         String assetManagerName,
                         String glossaryTermGUID,
                         String glossaryTermExternalIdentifier,
                         Date effectiveTime,
                         boolean forLineage,
                         boolean forDuplicateProcessing)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException
```
Remove the activity designation from the glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsContext(String userId,
                      String assetManagerGUID,
                      String assetManagerName,
                      String glossaryTermGUID,
                      String glossaryTermExternalIdentifier,
                      GlossaryTermContextDefinition contextDefinition,
                      Date effectiveTime,
                      boolean forLineage,
                      boolean forDuplicateProcessing)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException
```
Classify the glossary term to indicate that it describes a context.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

contextDefinition - more details of the context

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermAsContext(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String glossaryTermGUID,
                        String glossaryTermExternalIdentifier,
                        Date effectiveTime,
                        boolean forLineage,
                        boolean forDuplicateProcessing)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
Remove the context definition designation from the glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsSpineObject(String userId,
                          String assetManagerGUID,
                          String assetManagerName,
                          String glossaryTermGUID,
                          String glossaryTermExternalIdentifier,
                          Date effectiveTime,
                          boolean forLineage,
                          boolean forDuplicateProcessing)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException
```
Classify the glossary term to indicate that it describes a spine object.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermAsSpineObject(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String glossaryTermGUID,
                            String glossaryTermExternalIdentifier,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
Remove the spine object designation from the glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsSpineAttribute(String userId,
                             String assetManagerGUID,
                             String assetManagerName,
                             String glossaryTermGUID,
                             String glossaryTermExternalIdentifier,
                             Date effectiveTime,
                             boolean forLineage,
                             boolean forDuplicateProcessing)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
Classify the glossary term to indicate that it describes a spine attribute.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void clearTermAsSpineAttribute(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier,
                               Date effectiveTime,
                               boolean forLineage,
                               boolean forDuplicateProcessing)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Remove the spine attribute designation from the glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void setTermAsObjectIdentifier(String userId,
                               String assetManagerGUID,
                               String assetManagerName,
                               String glossaryTermGUID,
                               String glossaryTermExternalIdentifier,
                               Date effectiveTime,
                               boolean forLineage,
                               boolean forDuplicateProcessing)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException
```
Classify the glossary term to indicate that it describes an object identifier.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to update

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

void clearTermAsObjectIdentifier(String userId,
                                 String assetManagerGUID,
                                 String assetManagerName,
                                 String glossaryTermGUID,
                                 String glossaryTermExternalIdentifier,
                                 Date effectiveTime,
                                 boolean forLineage,
                                 boolean forDuplicateProcessing)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Remove the object identifier designation from the glossary term.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryTermGUID - unique identifier of the metadata element to update; glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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
```
void removeGlossaryTerm(String userId,
                        String assetManagerGUID,
                        String assetManagerName,
                        String glossaryTermGUID,
                        String glossaryTermExternalIdentifier,
                        Date effectiveTime,
                        boolean forLineage,
                        boolean forDuplicateProcessing)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException
```
Remove the metadata element representing a glossary term.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

glossaryTermGUID - unique identifier of the metadata element to remove

glossaryTermExternalIdentifier - unique identifier of the glossary term in the external asset manager

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

List<GlossaryTermElement> findGlossaryTerms(String userId,
                                            String assetManagerGUID,
                                            String assetManagerName,
                                            String searchString,
                                            int startFrom,
                                            int pageSize,
                                            Date effectiveTime,
                                            boolean forLineage,
                                            boolean forDuplicateProcessing)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            PropertyServerException

Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; searchString - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of matching metadata elements
Throws:: 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

List<GlossaryTermElement> getTermsForGlossary(String userId,
                                              String assetManagerGUID,
                                              String assetManagerName,
                                              String glossaryGUID,
                                              int startFrom,
                                              int pageSize,
                                              Date effectiveTime,
                                              boolean forLineage,
                                              boolean forDuplicateProcessing)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the list of glossary terms associated with a glossary.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryGUID - unique identifier of the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of associated metadata elements
Throws:: 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

List<GlossaryTermElement> getTermsForGlossaryCategory(String userId,
                                                      String assetManagerGUID,
                                                      String assetManagerName,
                                                      String glossaryCategoryGUID,
                                                      int startFrom,
                                                      int pageSize,
                                                      Date effectiveTime,
                                                      boolean forLineage,
                                                      boolean forDuplicateProcessing)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Retrieve the list of glossary terms associated with a glossary category.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryCategoryGUID - unique identifier of the glossary category of interest; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of associated metadata elements
Throws:: 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

List<GlossaryTermElement> getGlossaryTermsByName(String userId,
                                                 String assetManagerGUID,
                                                 String assetManagerName,
                                                 String name,
                                                 int startFrom,
                                                 int pageSize,
                                                 Date effectiveTime,
                                                 boolean forLineage,
                                                 boolean forDuplicateProcessing)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; name - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of matching metadata elements
Throws:: 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

GlossaryTermElement getGlossaryTermByGUID(String userId,
                                          String assetManagerGUID,
                                          String assetManagerName,
                                          String glossaryTermGUID,
                                          Date effectiveTime,
                                          boolean forLineage,
                                          boolean forDuplicateProcessing)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException

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

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryTermGUID - unique identifier of the requested metadata element; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: matching metadata element
Throws:: 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
```
String createExternalGlossaryLink(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  ExternalGlossaryLinkProperties linkProperties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

linkProperties - properties of the link

Returns:

unique identifier of the external reference

Throws:

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

void updateExternalGlossaryLink(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String externalLinkGUID,
                                boolean isMergeUpdate,
                                ExternalGlossaryLinkProperties linkProperties,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Update the properties of a reference to an external glossary resource.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; externalLinkGUID - unique identifier of the external reference; isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?; linkProperties - properties of the link; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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
```
void removeExternalGlossaryLink(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String externalLinkGUID,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

void attachExternalLinkToGlossary(String userId,
                                  String assetManagerGUID,
                                  String assetManagerName,
                                  String externalLinkGUID,
                                  String glossaryGUID,
                                  Date effectiveTime,
                                  boolean forLineage,
                                  boolean forDuplicateProcessing)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Connect a glossary to a reference to an external glossary resource.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to attach; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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

void detachExternalLinkFromGlossary(String userId,
                                    String assetManagerGUID,
                                    String assetManagerName,
                                    String externalLinkGUID,
                                    String glossaryGUID,
                                    Date effectiveTime,
                                    boolean forLineage,
                                    boolean forDuplicateProcessing)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Disconnect a glossary from a reference to an external glossary resource.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to remove; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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

List<ExternalGlossaryLinkElement> getExternalLinksForGlossary(String userId,
                                                              String assetManagerGUID,
                                                              String assetManagerName,
                                                              String glossaryGUID,
                                                              int startFrom,
                                                              int pageSize,
                                                              Date effectiveTime,
                                                              boolean forLineage,
                                                              boolean forDuplicateProcessing)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Retrieve the list of links to external glossary resources attached to a glossary.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; glossaryGUID - unique identifier of the metadata element for the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of attached links to external glossary resources
Throws:: 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

List<GlossaryElement> getGlossariesForExternalLink(String userId,
                                                   String assetManagerGUID,
                                                   String assetManagerName,
                                                   String externalLinkGUID,
                                                   int startFrom,
                                                   int pageSize,
                                                   Date effectiveTime,
                                                   boolean forLineage,
                                                   boolean forDuplicateProcessing)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException

Return the glossaries connected to an external glossary source.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; 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; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of glossaries
Throws:: 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
```
void attachExternalCategoryLink(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String externalLinkGUID,
                                String glossaryCategoryGUID,
                                ExternalGlossaryElementLinkProperties linkProperties,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryCategoryGUID - unique identifier for the glossary category

linkProperties - properties of the link

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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

void detachExternalCategoryLink(String userId,
                                String assetManagerGUID,
                                String assetManagerName,
                                String externalLinkGUID,
                                String glossaryCategoryGUID,
                                Date effectiveTime,
                                boolean forLineage,
                                boolean forDuplicateProcessing)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the link to an external glossary category resource.

Parameters:: userId - calling user; assetManagerGUID - unique identifier of software capability representing the caller; assetManagerName - unique name of software capability representing the caller; externalLinkGUID - unique identifier of the external reference; glossaryCategoryGUID - unique identifier for the glossary category; effectiveTime - the time that the retrieved elements must be effective for; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Throws:: 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
```
void attachExternalTermLink(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String externalLinkGUID,
                            String glossaryTermGUID,
                            ExternalGlossaryElementLinkProperties linkProperties,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
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:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryTermGUID - unique identifier for the glossary category

linkProperties - properties of the link

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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
```
void detachExternalTermLink(String userId,
                            String assetManagerGUID,
                            String assetManagerName,
                            String externalLinkGUID,
                            String glossaryTermGUID,
                            Date effectiveTime,
                            boolean forLineage,
                            boolean forDuplicateProcessing)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
```
Remove the link to an external glossary term resource.

Parameters:

userId - calling user

assetManagerGUID - unique identifier of software capability representing the caller

assetManagerName - unique name of software capability representing the caller

externalLinkGUID - unique identifier of the external reference

glossaryTermGUID - unique identifier for the glossary category

effectiveTime - the time that the retrieved elements must be effective for

forLineage - return elements marked with the Memento classification?

forDuplicateProcessing - do not merge elements marked as duplicates?

Throws:

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)

Interface GlossaryExchangeInterface

Method Summary

Method Detail

createGlossary

createGlossaryFromTemplate

updateGlossary

setGlossaryAsTaxonomy

clearGlossaryAsTaxonomy

setGlossaryAsCanonical

clearGlossaryAsCanonical

removeGlossary

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