java.lang.Object
- org.odpi.openmetadata.accessservices.assetmanager.server.spring.GlossaryExchangeResource

@RestController
@RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-manager/users/{userId}")
public class GlossaryExchangeResource
extends Object

GlossaryExchangeResource is the server-side implementation of the Asset Manager OMAS's support for glossaries. It matches the GlossaryExchangeClient.

Constructor Summary

Constructors
Constructor Description

GlossaryExchangeResource()
Default constructor

Method Summary

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

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

Constructor Detail
- GlossaryExchangeResource
```
public GlossaryExchangeResource()
```
  Default constructor

Method Detail

createGlossary
```
@PostMapping(path="/glossaries")
public GUIDResponse createGlossary(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @RequestBody
                                   GlossaryRequestBody requestBody)
```
Create a new metadata element to represent the root of a glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.

Parameters:

serverName - name of the server to route the request to.

userId - calling user

requestBody - properties to store

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createGlossaryFromTemplate
```
@PostMapping(path="/glossaries/from-template/{templateGUID}")
public GUIDResponse createGlossaryFromTemplate(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String templateGUID,
                                               @RequestBody
                                               TemplateRequestBody requestBody)
```
Create a new metadata element to represent a glossary using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new glossary. All categories and terms are linked to a single glossary. They are owned by this glossary and if the glossary is deleted, any linked terms and categories are deleted as well.

Parameters:

serverName - name of the server to route the request to

userId - calling user

templateGUID - unique identifier of the metadata element to copy

requestBody - properties that override the template

Returns:

unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGlossary

@PostMapping(path="/glossaries/{glossaryGUID}")
public VoidResponse updateGlossary(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String glossaryGUID,
                                   @RequestParam(required=false,defaultValue="false")
                                   boolean isMergeUpdate,
                                   @RequestBody
                                   GlossaryRequestBody requestBody)

Update the metadata element representing a glossary.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the metadata element to update; isMergeUpdate - should the properties be merged with the existing properties or completely over-write them; requestBody - new properties for this element
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/remove")
public VoidResponse removeGlossary(@PathVariable
                                   String serverName,
                                   @PathVariable
                                   String userId,
                                   @PathVariable
                                   String glossaryGUID,
                                   @RequestBody(required=false)
                                   MetadataCorrelationProperties requestBody)

Remove the metadata element representing a glossary. This will delete the glossary and all categories and terms.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the metadata element to remove; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setGlossaryAsTaxonomy
```
@PostMapping(path="/glossaries/{glossaryGUID}/is-taxonomy")
public VoidResponse setGlossaryAsTaxonomy(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String glossaryGUID,
                                          @RequestBody
                                          TaxonomyClassificationRequestBody requestBody)
```
Classify the glossary to indicate that it can be used as a taxonomy. This means each term is attached to one, and only one category and the categories are organized as a hierarchy with a single root category. Taxonomies are used as a way of organizing assets and other related metadata. The terms in the taxonomy are linked to the assets etc. and as such they are logically categorized by the linked category.

Parameters:

serverName - name of the server to route the request to

userId - calling user

glossaryGUID - unique identifier of the metadata element to remove

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearGlossaryAsTaxonomy

@PostMapping(path="/glossaries/{glossaryGUID}/is-taxonomy/remove")
public VoidResponse clearGlossaryAsTaxonomy(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String glossaryGUID,
                                            @RequestBody(required=false)
                                            MetadataCorrelationProperties requestBody)

Remove the taxonomy designation from the glossary.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the metadata element to remove; requestBody - correlation properties for the external asset manager
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setGlossaryAsCanonical
```
@PostMapping(path="/glossaries/{glossaryGUID}/is-canonical")
public VoidResponse setGlossaryAsCanonical(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryGUID,
                                           @RequestBody
                                           CanonicalVocabularyClassificationRequestBody requestBody)
```
Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name. This means there is only one definition for each term. Typically, the terms are also of a similar level of granularity and are limited to a specific scope of use. Canonical vocabularies are used to semantically classify assets in an unambiguous way.

Parameters:

serverName - name of the server to route the request to

userId - calling user

glossaryGUID - unique identifier of the metadata element to remove

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

Returns:

void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearGlossaryAsCanonical

@PostMapping(path="/glossaries/{glossaryGUID}/is-canonical/remove")
public VoidResponse clearGlossaryAsCanonical(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String glossaryGUID,
                                             @RequestBody(required=false)
                                             MetadataCorrelationProperties requestBody)

Remove the canonical designation from the glossary.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the metadata element to remove; requestBody - correlation properties for the external asset manager
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

findGlossaries

@PostMapping(path="/glossaries/by-search-string")
public GlossaryElementsResponse findGlossaries(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @RequestParam
                                               int startFrom,
                                               @RequestParam
                                               int pageSize,
                                               @RequestBody
                                               SearchStringRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; requestBody - string to find in the properties; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossariesByName

@PostMapping(path="/glossaries/by-name")
public GlossaryElementsResponse getGlossariesByName(@PathVariable
                                                    String serverName,
                                                    @PathVariable
                                                    String userId,
                                                    @RequestParam
                                                    int startFrom,
                                                    @RequestParam
                                                    int pageSize,
                                                    @RequestBody
                                                    NameRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; requestBody - name to search for; startFrom - paging start point; pageSize - maximum results that can be returned
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossariesForAssetManager

@PostMapping(path="/glossaries/by-asset-manager")
public GlossaryElementsResponse getGlossariesForAssetManager(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @RequestParam
                                                             int startFrom,
                                                             @RequestParam
                                                             int pageSize,
                                                             @RequestBody
                                                             AssetManagerIdentifiersRequestBody requestBody)

Retrieve the list of glossaries created by this caller.

Parameters:: serverName - name of the server to route the request to; userId - calling user; startFrom - paging start point; pageSize - maximum results that can be returned; requestBody - asset manager identifiers
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryByGUID

@PostMapping(path="/glossaries/{glossaryGUID}/retrieve")
public GlossaryElementResponse getGlossaryByGUID(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String glossaryGUID,
                                                 @RequestBody(required=false)
                                                 AssetManagerIdentifiersRequestBody requestBody)

Retrieve the glossary metadata element with the supplied unique identifier.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the requested metadata element; requestBody - asset manager identifiers
Returns:: matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createGlossaryCategory

@PostMapping(path="/glossaries/{glossaryGUID}/categories")
public GUIDResponse createGlossaryCategory(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryGUID,
                                           @RequestBody
                                           GlossaryCategoryRequestBody requestBody)

Create a new metadata element to represent a glossary category.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the glossary where the category is located; requestBody - properties about the glossary category to store
Returns:: unique identifier of the new glossary category or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createGlossaryCategoryFromTemplate

@PostMapping(path="/glossaries/categories/from-template/{templateGUID}")
public GUIDResponse createGlossaryCategoryFromTemplate(@PathVariable
                                                       String serverName,
                                                       @PathVariable
                                                       String userId,
                                                       @PathVariable
                                                       String templateGUID,
                                                       @RequestBody
                                                       TemplateRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; templateGUID - unique identifier of the metadata element to copy; requestBody - properties that override the template
Returns:: unique identifier of the new glossary category or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGlossaryCategory

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}")
public VoidResponse updateGlossaryCategory(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryCategoryGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody
                                           GlossaryCategoryRequestBody requestBody)

Update the metadata element representing a glossary category.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - new properties for the metadata element
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupCategoryParent

@PostMapping(path="/glossaries/categories/{glossaryParentCategoryGUID}/subcategories/{glossaryChildCategoryGUID}")
public VoidResponse setupCategoryParent(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String glossaryParentCategoryGUID,
                                        @PathVariable
                                        String glossaryChildCategoryGUID,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forLineage,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forDuplicateProcessing,
                                        @RequestBody(required=false)
                                        RelationshipRequestBody requestBody)

Create a parent-child relationship between two categories.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category; glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearCategoryParent

@PostMapping(path="/glossaries/categories/{glossaryParentCategoryGUID}/subcategories/{glossaryChildCategoryGUID}/remove")
public VoidResponse clearCategoryParent(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String glossaryParentCategoryGUID,
                                        @PathVariable
                                        String glossaryChildCategoryGUID,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forLineage,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forDuplicateProcessing,
                                        @RequestBody(required=false)
                                        EffectiveTimeQueryRequestBody requestBody)

Remove a parent-child relationship between two categories.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryParentCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the super-category; glossaryChildCategoryGUID - unique identifier of the glossary category in the external asset manager that is to be the subcategory; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeGlossaryCategory

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/remove")
public VoidResponse removeGlossaryCategory(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryCategoryGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody(required=false)
                                           UpdateRequestBody requestBody)

Remove the metadata element representing a glossary category.

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

findGlossaryCategories

@PostMapping(path="/glossaries/categories/by-search-string")
public GlossaryCategoryElementsResponse findGlossaryCategories(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestParam
                                                               int startFrom,
                                                               @RequestParam
                                                               int pageSize,
                                                               @RequestParam(required=false,defaultValue="false")
                                                               boolean forLineage,
                                                               @RequestParam(required=false,defaultValue="false")
                                                               boolean forDuplicateProcessing,
                                                               @RequestBody
                                                               SearchStringRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - string to find in the properties and correlators
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getCategoriesForGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/categories/retrieve")
public GlossaryCategoryElementsResponse getCategoriesForGlossary(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String glossaryGUID,
                                                                 @RequestParam
                                                                 int startFrom,
                                                                 @RequestParam
                                                                 int pageSize,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forLineage,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forDuplicateProcessing,
                                                                 @RequestBody(required=false)
                                                                 EffectiveTimeQueryRequestBody requestBody)

Return the list of categories associated with a glossary.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the glossary to query; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: list of metadata elements describing the categories associated with the requested glossary or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryCategoriesByName

@PostMapping(path="/glossaries/categories/by-name")
public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @RequestParam
                                                                    int startFrom,
                                                                    @RequestParam
                                                                    int pageSize,
                                                                    @RequestParam(required=false,defaultValue="false")
                                                                    boolean forLineage,
                                                                    @RequestParam(required=false,defaultValue="false")
                                                                    boolean forDuplicateProcessing,
                                                                    @RequestBody
                                                                    NameRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; requestBody - name to search for and correlators; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryCategoryByGUID

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/retrieve")
public GlossaryCategoryElementResponse getGlossaryCategoryByGUID(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String glossaryCategoryGUID,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forLineage,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forDuplicateProcessing,
                                                                 @RequestBody(required=false)
                                                                 EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the requested metadata element; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryCategoryParent

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/parent/retrieve")
public GlossaryCategoryElementResponse getGlossaryCategoryParent(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String glossaryCategoryGUID,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forLineage,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forDuplicateProcessing,
                                                                 @RequestBody(required=false)
                                                                 EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the requested metadata element; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: parent glossary category element or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getGlossarySubCategories

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/subcategories/retrieve")
public GlossaryCategoryElementsResponse getGlossarySubCategories(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String glossaryCategoryGUID,
                                                                 @RequestParam
                                                                 int startFrom,
                                                                 @RequestParam
                                                                 int pageSize,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forLineage,
                                                                 @RequestParam(required=false,defaultValue="false")
                                                                 boolean forDuplicateProcessing,
                                                                 @RequestBody(required=false)
                                                                 EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the requested metadata element; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: list of glossary category elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createGlossaryTerm

@PostMapping(path="/glossaries/{glossaryGUID}/terms")
public GUIDResponse createGlossaryTerm(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String glossaryGUID,
                                       @RequestBody
                                       GlossaryTermRequestBody requestBody)

Create a new metadata element to represent a glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the glossary where the term is located; requestBody - properties for the glossary term
Returns:: unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createControlledGlossaryTerm

@PostMapping(path="/glossaries/{glossaryGUID}/terms/new-controlled")
public GUIDResponse createControlledGlossaryTerm(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String glossaryGUID,
                                                 @RequestBody
                                                 ControlledGlossaryTermRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the glossary where the term is located; requestBody - properties for the glossary term
Returns:: unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createGlossaryTermFromTemplate

@PostMapping(path="/glossaries/terms/from-template/{templateGUID}")
public GUIDResponse createGlossaryTermFromTemplate(@PathVariable
                                                   String serverName,
                                                   @PathVariable
                                                   String userId,
                                                   @PathVariable
                                                   String templateGUID,
                                                   @RequestBody
                                                   TemplateRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; templateGUID - unique identifier of the metadata element to copy; requestBody - properties that override the template
Returns:: unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGlossaryTerm

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}")
public VoidResponse updateGlossaryTerm(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String glossaryTermGUID,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forLineage,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forDuplicateProcessing,
                                       @RequestBody
                                       GlossaryTermRequestBody requestBody)

Update the metadata element representing a glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the glossary term to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - new properties for the glossary term
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateGlossaryTermStatus

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/status")
public VoidResponse updateGlossaryTermStatus(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String glossaryTermGUID,
                                             @RequestParam(required=false,defaultValue="false")
                                             boolean forLineage,
                                             @RequestParam(required=false,defaultValue="false")
                                             boolean forDuplicateProcessing,
                                             @RequestBody
                                             GlossaryTermStatusRequestBody requestBody)

Update the status of the metadata element representing a glossary term. This is only valid on a controlled glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the glossary term to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - status and correlation properties
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupTermCategory

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/terms/{glossaryTermGUID}")
public VoidResponse setupTermCategory(@PathVariable
                                      String serverName,
                                      @PathVariable
                                      String userId,
                                      @PathVariable
                                      String glossaryCategoryGUID,
                                      @PathVariable
                                      String glossaryTermGUID,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forLineage,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forDuplicateProcessing,
                                      @RequestBody
                                      RelationshipRequestBody requestBody)

Link a term to a category.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the glossary category; glossaryTermGUID - unique identifier of the glossary term; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties for the categorization relationship
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermCategory

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/terms/{glossaryTermGUID}/remove")
public VoidResponse clearTermCategory(@PathVariable
                                      String serverName,
                                      @PathVariable
                                      String userId,
                                      @PathVariable
                                      String glossaryCategoryGUID,
                                      @PathVariable
                                      String glossaryTermGUID,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forLineage,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forDuplicateProcessing,
                                      @RequestBody(required=false)
                                      EffectiveTimeQueryRequestBody requestBody)

Unlink a term from a category.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the glossary category; glossaryTermGUID - unique identifier of the glossary term; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setupTermRelationship

@PostMapping(path="/glossaries/terms/{glossaryTermOneGUID}/relationships/{relationshipTypeName}/terms/{glossaryTermTwoGUID}")
public VoidResponse setupTermRelationship(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String glossaryTermOneGUID,
                                          @PathVariable
                                          String relationshipTypeName,
                                          @PathVariable
                                          String glossaryTermTwoGUID,
                                          @RequestParam(required=false,defaultValue="false")
                                          boolean forLineage,
                                          @RequestParam(required=false,defaultValue="false")
                                          boolean forDuplicateProcessing,
                                          @RequestBody
                                          RelationshipRequestBody requestBody)

Link two terms together using a specialist relationship.

Parameters:: serverName - name of the server to route the request to; userId - calling user; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties for the relationship
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateTermRelationship

@PostMapping(path="/glossaries/terms/{glossaryTermOneGUID}/relationships/{relationshipTypeName}/terms/{glossaryTermTwoGUID}/update")
public VoidResponse updateTermRelationship(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryTermOneGUID,
                                           @PathVariable
                                           String relationshipTypeName,
                                           @PathVariable
                                           String glossaryTermTwoGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody
                                           RelationshipRequestBody requestBody)

Update the relationship properties for the two terms.

Parameters:: serverName - name of the server to route the request to; userId - calling user; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties for the relationship
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermRelationship

@PostMapping(path="/glossaries/terms/{glossaryTermOneGUID}/relationships/{relationshipTypeName}/terms/{glossaryTermTwoGUID}/remove")
public VoidResponse clearTermRelationship(@PathVariable
                                          String serverName,
                                          @PathVariable
                                          String userId,
                                          @PathVariable
                                          String glossaryTermOneGUID,
                                          @PathVariable
                                          String relationshipTypeName,
                                          @PathVariable
                                          String glossaryTermTwoGUID,
                                          @RequestParam(required=false,defaultValue="false")
                                          boolean forLineage,
                                          @RequestParam(required=false,defaultValue="false")
                                          boolean forDuplicateProcessing,
                                          @RequestBody(required=false)
                                          EffectiveTimeQueryRequestBody requestBody)

Remove the relationship between two terms.

Parameters:: serverName - name of the server to route the request to; userId - calling user; relationshipTypeName - name of the type of relationship to create; glossaryTermOneGUID - unique identifier of the glossary term at end 1; glossaryTermTwoGUID - unique identifier of the glossary term at end 2; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties of the relationship
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsAbstractConcept

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-abstract-concept")
public VoidResponse setTermAsAbstractConcept(@PathVariable
                                             String serverName,
                                             @PathVariable
                                             String userId,
                                             @PathVariable
                                             String glossaryTermGUID,
                                             @RequestParam(required=false,defaultValue="false")
                                             boolean forLineage,
                                             @RequestParam(required=false,defaultValue="false")
                                             boolean forDuplicateProcessing,
                                             @RequestBody(required=false)
                                             UpdateRequestBody requestBody)

Classify the glossary term to indicate that it describes an abstract concept.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsAbstractConcept

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-abstract-concept/remove")
public VoidResponse clearTermAsAbstractConcept(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String glossaryTermGUID,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forLineage,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forDuplicateProcessing,
                                               @RequestBody(required=false)
                                               UpdateRequestBody requestBody)

Remove the abstract concept designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsDataValue

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-data-value")
public VoidResponse setTermAsDataValue(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String glossaryTermGUID,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forLineage,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forDuplicateProcessing,
                                       @RequestBody(required=false)
                                       UpdateRequestBody requestBody)

Classify the glossary term to indicate that it describes a data value.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsDataValue

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-data-value/remove")
public VoidResponse clearTermAsDataValue(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String glossaryTermGUID,
                                         @RequestParam(required=false,defaultValue="false")
                                         boolean forLineage,
                                         @RequestParam(required=false,defaultValue="false")
                                         boolean forDuplicateProcessing,
                                         @RequestBody(required=false)
                                         UpdateRequestBody requestBody)

Remove the data value designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsActivity

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-activity")
public VoidResponse setTermAsActivity(@PathVariable
                                      String serverName,
                                      @PathVariable
                                      String userId,
                                      @PathVariable
                                      String glossaryTermGUID,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forLineage,
                                      @RequestParam(required=false,defaultValue="false")
                                      boolean forDuplicateProcessing,
                                      @RequestBody
                                      ActivityTermClassificationRequestBody requestBody)

Classify the glossary term to indicate that it describes a data value.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - type of activity and correlators
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsActivity

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-activity/remove")
public VoidResponse clearTermAsActivity(@PathVariable
                                        String serverName,
                                        @PathVariable
                                        String userId,
                                        @PathVariable
                                        String glossaryTermGUID,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forLineage,
                                        @RequestParam(required=false,defaultValue="false")
                                        boolean forDuplicateProcessing,
                                        @RequestBody(required=false)
                                        UpdateRequestBody requestBody)

Remove the activity designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsContext

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-context-definition")
public VoidResponse setTermAsContext(@PathVariable
                                     String serverName,
                                     @PathVariable
                                     String userId,
                                     @PathVariable
                                     String glossaryTermGUID,
                                     @RequestParam(required=false,defaultValue="false")
                                     boolean forLineage,
                                     @RequestParam(required=false,defaultValue="false")
                                     boolean forDuplicateProcessing,
                                     @RequestBody
                                     ContextDefinitionClassificationRequestBody requestBody)

Classify the glossary term to indicate that it describes a context.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - more details of the context
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsContext

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-context-definition/remove")
public VoidResponse clearTermAsContext(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String glossaryTermGUID,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forLineage,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forDuplicateProcessing,
                                       @RequestBody(required=false)
                                       UpdateRequestBody requestBody)

Remove the context definition designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsSpineObject

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-spine-object")
public VoidResponse setTermAsSpineObject(@PathVariable
                                         String serverName,
                                         @PathVariable
                                         String userId,
                                         @PathVariable
                                         String glossaryTermGUID,
                                         @RequestParam(required=false,defaultValue="false")
                                         boolean forLineage,
                                         @RequestParam(required=false,defaultValue="false")
                                         boolean forDuplicateProcessing,
                                         @RequestBody(required=false)
                                         UpdateRequestBody requestBody)

Classify the glossary term to indicate that it describes a spine object.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsSpineObject

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-spine-object/remove")
public VoidResponse clearTermAsSpineObject(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String glossaryTermGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody(required=false)
                                           UpdateRequestBody requestBody)

Remove the spine object designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsSpineAttribute

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-spine-attribute")
public VoidResponse setTermAsSpineAttribute(@PathVariable
                                            String serverName,
                                            @PathVariable
                                            String userId,
                                            @PathVariable
                                            String glossaryTermGUID,
                                            @RequestParam(required=false,defaultValue="false")
                                            boolean forLineage,
                                            @RequestParam(required=false,defaultValue="false")
                                            boolean forDuplicateProcessing,
                                            @RequestBody(required=false)
                                            UpdateRequestBody requestBody)

Classify the glossary term to indicate that it describes a spine attribute.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsSpineAttribute

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-spine-attribute/remove")
public VoidResponse clearTermAsSpineAttribute(@PathVariable
                                              String serverName,
                                              @PathVariable
                                              String userId,
                                              @PathVariable
                                              String glossaryTermGUID,
                                              @RequestParam(required=false,defaultValue="false")
                                              boolean forLineage,
                                              @RequestParam(required=false,defaultValue="false")
                                              boolean forDuplicateProcessing,
                                              @RequestBody(required=false)
                                              UpdateRequestBody requestBody)

Remove the spine attribute designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

setTermAsObjectIdentifier

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-object-identifier")
public VoidResponse setTermAsObjectIdentifier(@PathVariable
                                              String serverName,
                                              @PathVariable
                                              String userId,
                                              @PathVariable
                                              String glossaryTermGUID,
                                              @RequestParam(required=false,defaultValue="false")
                                              boolean forLineage,
                                              @RequestParam(required=false,defaultValue="false")
                                              boolean forDuplicateProcessing,
                                              @RequestBody(required=false)
                                              UpdateRequestBody requestBody)

Classify the glossary term to indicate that it describes an object identifier.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

clearTermAsObjectIdentifier

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/is-object-identifier/remove")
public VoidResponse clearTermAsObjectIdentifier(@PathVariable
                                                String serverName,
                                                @PathVariable
                                                String userId,
                                                @PathVariable
                                                String glossaryTermGUID,
                                                @RequestParam(required=false,defaultValue="false")
                                                boolean forLineage,
                                                @RequestParam(required=false,defaultValue="false")
                                                boolean forDuplicateProcessing,
                                                @RequestBody(required=false)
                                                UpdateRequestBody requestBody)

Remove the object identifier designation from the glossary term.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the metadata element to update; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeGlossaryTerm

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/remove")
public VoidResponse removeGlossaryTerm(@PathVariable
                                       String serverName,
                                       @PathVariable
                                       String userId,
                                       @PathVariable
                                       String glossaryTermGUID,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forLineage,
                                       @RequestParam(required=false,defaultValue="false")
                                       boolean forDuplicateProcessing,
                                       @RequestBody(required=false)
                                       UpdateRequestBody requestBody)

Remove the metadata element representing a glossary term.

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

findGlossaryTerms

@PostMapping(path="/glossaries/terms/by-search-string")
public GlossaryTermElementsResponse findGlossaryTerms(@PathVariable
                                                      String serverName,
                                                      @PathVariable
                                                      String userId,
                                                      @RequestParam
                                                      int startFrom,
                                                      @RequestParam
                                                      int pageSize,
                                                      @RequestParam(required=false,defaultValue="false")
                                                      boolean forLineage,
                                                      @RequestParam(required=false,defaultValue="false")
                                                      boolean forDuplicateProcessing,
                                                      @RequestBody
                                                      SearchStringRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers and search string
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getTermsForGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/terms/retrieve")
public GlossaryTermElementsResponse getTermsForGlossary(@PathVariable
                                                        String serverName,
                                                        @PathVariable
                                                        String userId,
                                                        @PathVariable
                                                        String glossaryGUID,
                                                        @RequestParam
                                                        int startFrom,
                                                        @RequestParam
                                                        int pageSize,
                                                        @RequestParam(required=false,defaultValue="false")
                                                        boolean forLineage,
                                                        @RequestParam(required=false,defaultValue="false")
                                                        boolean forDuplicateProcessing,
                                                        @RequestBody(required=false)
                                                        EffectiveTimeQueryRequestBody requestBody)

Retrieve the list of glossary terms associated with a glossary.

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getTermsForGlossaryCategory

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/terms/retrieve")
public GlossaryTermElementsResponse getTermsForGlossaryCategory(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String glossaryCategoryGUID,
                                                                @RequestParam
                                                                int startFrom,
                                                                @RequestParam
                                                                int pageSize,
                                                                @RequestParam(required=false,defaultValue="false")
                                                                boolean forLineage,
                                                                @RequestParam(required=false,defaultValue="false")
                                                                boolean forDuplicateProcessing,
                                                                @RequestBody(required=false)
                                                                EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryCategoryGUID - unique identifier of the glossary category of interest; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryTermsByName

@PostMapping(path="/glossaries/terms/by-name")
public GlossaryTermElementsResponse getGlossaryTermsByName(@PathVariable
                                                           String serverName,
                                                           @PathVariable
                                                           String userId,
                                                           @RequestParam
                                                           int startFrom,
                                                           @RequestParam
                                                           int pageSize,
                                                           @RequestParam(required=false,defaultValue="false")
                                                           boolean forLineage,
                                                           @RequestParam(required=false,defaultValue="false")
                                                           boolean forDuplicateProcessing,
                                                           @RequestBody
                                                           NameRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers and name
Returns:: list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossaryTermByGUID

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/retrieve")
public GlossaryTermElementResponse getGlossaryTermByGUID(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @PathVariable
                                                         String glossaryTermGUID,
                                                         @RequestParam(required=false,defaultValue="false")
                                                         boolean forLineage,
                                                         @RequestParam(required=false,defaultValue="false")
                                                         boolean forDuplicateProcessing,
                                                         @RequestBody(required=false)
                                                         EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryTermGUID - unique identifier of the requested metadata element; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

createExternalGlossaryLink
```
@PostMapping(path="/glossaries/external-links")
public GUIDResponse createExternalGlossaryLink(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @RequestBody
                                               ExternalGlossaryLinkRequestBody requestBody)
```
Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Parameters:

serverName - name of the server to route the request to

userId - calling user

requestBody - properties of the link

Returns:

unique identifier of the external reference or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

updateExternalGlossaryLink

@PostMapping(path="/glossaries/external-links/{externalLinkGUID}")
public VoidResponse updateExternalGlossaryLink(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String externalLinkGUID,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forLineage,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forDuplicateProcessing,
                                               @RequestBody
                                               ExternalGlossaryLinkRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties of the link
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

removeExternalGlossaryLink

@PostMapping(path="/glossaries/external-links/{externalLinkGUID}/remove")
public VoidResponse removeExternalGlossaryLink(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String externalLinkGUID,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forLineage,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forDuplicateProcessing,
                                               @RequestBody(required=false)
                                               EffectiveTimeQueryRequestBody requestBody)

Remove information about a link to an external glossary resource (and the relationships that attached it to the glossaries).

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

attachExternalLinkToGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/external-links/{externalLinkGUID}")
public VoidResponse attachExternalLinkToGlossary(@PathVariable
                                                 String serverName,
                                                 @PathVariable
                                                 String userId,
                                                 @PathVariable
                                                 String glossaryGUID,
                                                 @PathVariable
                                                 String externalLinkGUID,
                                                 @RequestParam(required=false,defaultValue="false")
                                                 boolean forLineage,
                                                 @RequestParam(required=false,defaultValue="false")
                                                 boolean forDuplicateProcessing,
                                                 @RequestBody(required=false)
                                                 EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to attach; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

detachExternalLinkFromGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/external-links/{externalLinkGUID}/remove")
public VoidResponse detachExternalLinkFromGlossary(@PathVariable
                                                   String serverName,
                                                   @PathVariable
                                                   String userId,
                                                   @PathVariable
                                                   String externalLinkGUID,
                                                   @PathVariable
                                                   String glossaryGUID,
                                                   @RequestParam(required=false,defaultValue="false")
                                                   boolean forLineage,
                                                   @RequestParam(required=false,defaultValue="false")
                                                   boolean forDuplicateProcessing,
                                                   @RequestBody(required=false)
                                                   EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryGUID - unique identifier of the metadata element to remove; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getExternalLinksForGlossary

@PostMapping(path="/glossaries/{glossaryGUID}/external-links/retrieve")
public ExternalGlossaryLinkElementsResponse getExternalLinksForGlossary(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String glossaryGUID,
                                                                        @RequestParam
                                                                        int startFrom,
                                                                        @RequestParam
                                                                        int pageSize,
                                                                        @RequestParam(required=false,defaultValue="false")
                                                                        boolean forLineage,
                                                                        @RequestParam(required=false,defaultValue="false")
                                                                        boolean forDuplicateProcessing,
                                                                        @RequestBody(required=false)
                                                                        EffectiveTimeQueryRequestBody requestBody)

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

Parameters:: serverName - name of the server to route the request to; userId - calling user; glossaryGUID - unique identifier of the metadata element for the glossary of interest; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - effective time
Returns:: list of attached links to external glossary resources or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

getGlossariesForExternalLink

@PostMapping(path="/glossaries/external-links/{externalLinkGUID}/retrieve")
public GlossaryElementsResponse getGlossariesForExternalLink(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String externalLinkGUID,
                                                             @RequestParam
                                                             int startFrom,
                                                             @RequestParam
                                                             int pageSize,
                                                             @RequestParam(required=false,defaultValue="false")
                                                             boolean forLineage,
                                                             @RequestParam(required=false,defaultValue="false")
                                                             boolean forDuplicateProcessing,
                                                             @RequestBody(required=false)
                                                             EffectiveTimeQueryRequestBody requestBody)

Return the glossaries connected to an external glossary source.

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the metadata element for the external glossary link of interest; startFrom - paging start point; pageSize - maximum results that can be returned; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: list of glossaries or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

attachExternalCategoryLink

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/external-links/{externalLinkGUID}")
public VoidResponse attachExternalCategoryLink(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String glossaryCategoryGUID,
                                               @PathVariable
                                               String externalLinkGUID,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forLineage,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forDuplicateProcessing,
                                               @RequestBody
                                               ExternalGlossaryElementLinkRequestBody requestBody)

Create a link to an external glossary category resource. This is associated with a category to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryCategoryGUID - unique identifier for the glossary category; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties of the link
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

detachExternalCategoryLink

@PostMapping(path="/glossaries/categories/{glossaryCategoryGUID}/external-links/{externalLinkGUID}/remove")
public VoidResponse detachExternalCategoryLink(@PathVariable
                                               String serverName,
                                               @PathVariable
                                               String userId,
                                               @PathVariable
                                               String externalLinkGUID,
                                               @PathVariable
                                               String glossaryCategoryGUID,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forLineage,
                                               @RequestParam(required=false,defaultValue="false")
                                               boolean forDuplicateProcessing,
                                               @RequestBody(required=false)
                                               EffectiveTimeQueryRequestBody requestBody)

Remove the link to an external glossary category resource.

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryCategoryGUID - unique identifier for the glossary category; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

attachExternalTermLink

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/external-links/{externalLinkGUID}")
public VoidResponse attachExternalTermLink(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String externalLinkGUID,
                                           @PathVariable
                                           String glossaryTermGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody
                                           ExternalGlossaryElementLinkRequestBody requestBody)

Create a link to an external glossary term resource. This is associated with a term to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryTermGUID - unique identifier for the glossary category; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - properties of the link
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

detachExternalTermLink

@PostMapping(path="/glossaries/terms/{glossaryTermGUID}/external-links/{externalLinkGUID}/remove")
public VoidResponse detachExternalTermLink(@PathVariable
                                           String serverName,
                                           @PathVariable
                                           String userId,
                                           @PathVariable
                                           String externalLinkGUID,
                                           @PathVariable
                                           String glossaryTermGUID,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forLineage,
                                           @RequestParam(required=false,defaultValue="false")
                                           boolean forDuplicateProcessing,
                                           @RequestBody(required=false)
                                           EffectiveTimeQueryRequestBody requestBody)

Remove the link to an external glossary term resource.

Parameters:: serverName - name of the server to route the request to; userId - calling user; externalLinkGUID - unique identifier of the external reference; glossaryTermGUID - unique identifier for the glossary category; forLineage - return elements marked with the Memento classification?; forDuplicateProcessing - do not merge elements marked as duplicates?; requestBody - asset manager identifiers
Returns:: void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

Class GlossaryExchangeResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryExchangeResource

Method Detail

createGlossary

createGlossaryFromTemplate

updateGlossary

removeGlossary

setGlossaryAsTaxonomy

clearGlossaryAsTaxonomy

setGlossaryAsCanonical

clearGlossaryAsCanonical

findGlossaries

getGlossariesByName

getGlossariesForAssetManager

getGlossaryByGUID

createGlossaryCategory

createGlossaryCategoryFromTemplate

updateGlossaryCategory

setupCategoryParent

clearCategoryParent

removeGlossaryCategory

findGlossaryCategories

getCategoriesForGlossary

getGlossaryCategoriesByName

getGlossaryCategoryByGUID

getGlossaryCategoryParent

getGlossarySubCategories

createGlossaryTerm

createControlledGlossaryTerm

createGlossaryTermFromTemplate

updateGlossaryTerm

updateGlossaryTermStatus

setupTermCategory

clearTermCategory

setupTermRelationship

updateTermRelationship

clearTermRelationship

setTermAsAbstractConcept

clearTermAsAbstractConcept

setTermAsDataValue

clearTermAsDataValue

setTermAsActivity

clearTermAsActivity

setTermAsContext

clearTermAsContext

setTermAsSpineObject

clearTermAsSpineObject

setTermAsSpineAttribute

clearTermAsSpineAttribute

setTermAsObjectIdentifier

clearTermAsObjectIdentifier

removeGlossaryTerm

findGlossaryTerms

getTermsForGlossary

getTermsForGlossaryCategory

getGlossaryTermsByName

getGlossaryTermByGUID

createExternalGlossaryLink

updateExternalGlossaryLink

removeExternalGlossaryLink

attachExternalLinkToGlossary

detachExternalLinkFromGlossary

getExternalLinksForGlossary

getGlossariesForExternalLink

attachExternalCategoryLink

detachExternalCategoryLink

attachExternalTermLink

detachExternalTermLink