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

Class GlossaryViewController

java.lang.Object

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

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

Deprecated.

This controller serves all requests for glossaries, categories and terms. The API originated in the Egeria UI Application. It is a temporary interface until the UI components are updated to call the main Glossary Browser OMVS.

Constructor Summary

Constructors

Constructor	Description
GlossaryViewController()	Deprecated.

Method Summary

Modifier and Type	Method	Description
List<Glossary>	getAllGlossaries(String serverName, Integer from, Integer size)	Deprecated. Retrieve the list of all glossaries.
List<GlossaryCategory>	getAllGlossaryCategories(String serverName, Integer from, Integer size)	Deprecated. Retrieve the list of all categories from all glossaries.
List<GlossaryTerm>	getAllGlossaryTerms(String serverName, Integer from, Integer size)	Deprecated. Retrieve the list of all glossary terms from all glossaries.
List<GlossaryTerm>	getAntonyms(String serverName, String termGUID, Integer from, Integer size)	Deprecated. Return the terms linked by the Antonym relationship.
List<GlossaryViewEntityDetail>	getAssignedElements(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getAttributes(String serverName, String termGUID, Integer from, Integer size)	Deprecated. Return glossary terms for the HASA relationship.
List<GlossaryCategory>	getCategories(String serverName, String glossaryGUID, Integer from, Integer size)	Deprecated. Retrieve all the categories from a specific glossary.
GlossaryCategory	getCategory(String serverName, String categoryGUID)	Deprecated.
Glossary	getCategoryHomeGlossary(String serverName, String categoryGUID)	Deprecated.
List<ExternalGlossaryLink>	getExternalGlossaryLinks(String serverName, String categoryGUID, Integer from, Integer size)	Deprecated.
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfGlossary(String serverName, String glossaryGUID, Integer from, Integer size)	Deprecated. Return the external links for a glossary.
List<ExternalGlossaryLink>	getExternalGlossaryLinksOfTerm(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
Glossary	getGlossary(String serverName, String glossaryGUID)	Deprecated. Retrieve a specific glossary.
List<GlossaryTerm>	getIsATerms(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getPreferredTerms(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getRelatedTerms(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getReplacementTerms(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryCategory>	getSubcategories(String serverName, String categoryGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getSubtypes(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getSynonyms(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
GlossaryTerm	getTerm(String serverName, String termGUID)	Deprecated. Return the antonym relationships.
Glossary	getTermHomeGlossary(String serverName, String termGUID)	Deprecated.
List<GlossaryTerm>	getTermsOfCategory(String serverName, String categoryGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getTermsOfGlossary(String serverName, String glossaryGUID, Integer from, Integer size)	Deprecated. Retrieve all the terms from a specific glossary.
List<GlossaryTerm>	getTranslations(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getTypedBys(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getUsedInContexts(String serverName, String termGUID, Integer from, Integer size)	Deprecated.
List<GlossaryTerm>	getValidValues(String serverName, String termGUID, Integer from, Integer size)	Deprecated.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GlossaryViewController

public GlossaryViewController()

Deprecated.

Method Details

getAllGlossaries

@GetMapping
public List<Glossary> getAllGlossaries(@PathVariable
 String serverName,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve the list of all glossaries.

Parameters:

serverName - name of the server to route the request to

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossaries

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getAllGlossaryTerms

@GetMapping("/terms")
public List<GlossaryTerm> getAllGlossaryTerms(@PathVariable
 String serverName,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve the list of all glossary terms from all glossaries.

Parameters:

serverName - name of the server to route the request to

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossary terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getAllGlossaryCategories

@GetMapping("/categories")
public List<GlossaryCategory> getAllGlossaryCategories(@PathVariable
 String serverName,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve the list of all categories from all glossaries.

Parameters:

serverName - name of the server to route the request to

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

all the glossary categories

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getGlossary

@GetMapping("/{glossaryGUID}")
public Glossary getGlossary(@PathVariable
 String serverName,
 @PathVariable("glossaryGUID")
 String glossaryGUID)
                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve a specific glossary.

Parameters:

serverName - name of the server to route the request to

glossaryGUID - GUID of the glossary to be retrieved

Returns:

the glossary with the GUID or null

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getCategories

@GetMapping("/{glossaryGUID}/categories")
public List<GlossaryCategory> getCategories(@PathVariable
 String serverName,
 @PathVariable("glossaryGUID")
 String glossaryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve all the categories from a specific glossary.

Parameters:

serverName - name of the server to route the request to

glossaryGUID - GUID of the glossary

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of categories

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTermsOfGlossary

@GetMapping("/{glossaryGUID}/terms")
public List<GlossaryTerm> getTermsOfGlossary(@PathVariable
 String serverName,
 @PathVariable("glossaryGUID")
 String glossaryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Retrieve all the terms from a specific glossary.

Parameters:

serverName - name of the server to route the request to

glossaryGUID - GUID of the glossary

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfGlossary

@GetMapping("/{glossaryGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinksOfGlossary(@PathVariable
 String serverName,
 @PathVariable("glossaryGUID")
 String glossaryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                                              throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Return the external links for a glossary.

Parameters:

serverName - name of the server to route the request to

glossaryGUID - GUID of the glossary

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of external glossary links

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTerm

@GetMapping("/terms/{termGUID}")
public GlossaryTerm getTerm(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID)
                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Return the antonym relationships.

Parameters:

termGUID - GUID of the term

Returns:

the term with the GUID

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getAntonyms

@GetMapping("/terms/{termGUID}/antonyms")
public List<GlossaryTerm> getAntonyms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Return the terms linked by the Antonym relationship.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of antonyms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getAssignedElements

@GetMapping("/terms/{termGUID}/assignedElements")
public List<GlossaryViewEntityDetail> getAssignedElements(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms representing the assigned elements

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getAttributes

@GetMapping("/terms/{termGUID}/attributes")
public List<GlossaryTerm> getAttributes(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Return glossary terms for the HASA relationship.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms representing the antonyms of the term with GUID

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getIsATerms

@GetMapping("/terms/{termGUID}/isA")
public List<GlossaryTerm> getIsATerms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of is-a terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getPreferredTerms

@GetMapping("/terms/{termGUID}/preferredTerms")
public List<GlossaryTerm> getPreferredTerms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of preferred terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getRelatedTerms

@GetMapping("/terms/{termGUID}/relatedTerms")
public List<GlossaryTerm> getRelatedTerms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of related terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getReplacementTerms

@GetMapping("/terms/{termGUID}/replacementTerms")
public List<GlossaryTerm> getReplacementTerms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of replacement terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getSubtypes

@GetMapping("/terms/{termGUID}/subtypes")
public List<GlossaryTerm> getSubtypes(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of subtypes terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getSynonyms

@GetMapping("/terms/{termGUID}/synonyms")
public List<GlossaryTerm> getSynonyms(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of synonym terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTranslations

@GetMapping("/terms/{termGUID}/translations")
public List<GlossaryTerm> getTranslations(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of translations terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTypedBys

@GetMapping("/terms/{termGUID}/types")
public List<GlossaryTerm> getTypedBys(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of preferred terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getUsedInContexts

@GetMapping("/terms/{termGUID}/usedInContext")
public List<GlossaryTerm> getUsedInContexts(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of "used-in-contexts" terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getValidValues

@GetMapping("/terms/{termGUID}/validValues")
public List<GlossaryTerm> getValidValues(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list valid values terms

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTermHomeGlossary

@GetMapping("/terms/{termGUID}/homeGlossary")
public Glossary getTermHomeGlossary(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

termGUID - GUID of the term

Returns:

term's home glossary

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getExternalGlossaryLinksOfTerm

@GetMapping("/terms/{termGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinksOfTerm(@PathVariable
 String serverName,
 @PathVariable("termGUID")
 String termGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                                          throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

termGUID - GUID of the term

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of term's external glossary links

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getCategory

@GetMapping("/categories/{categoryGUID}")
public GlossaryCategory getCategory(@PathVariable
 String serverName,
 @PathVariable("categoryGUID")
 String categoryGUID)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

categoryGUID - GUID of the category to be retrieved

Returns:

the glossary category with the GUID or null

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getCategoryHomeGlossary

@GetMapping("/categories/{categoryGUID}/homeGlossary")
public Glossary getCategoryHomeGlossary(@PathVariable
 String serverName,
 @PathVariable("categoryGUID")
 String categoryGUID)
                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

categoryGUID - GUID of the category

Returns:

the home glossary of the category

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getSubcategories

@GetMapping("/categories/{categoryGUID}/subcategories")
public List<GlossaryCategory> getSubcategories(@PathVariable
 String serverName,
 @PathVariable("categoryGUID")
 String categoryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

categoryGUID - GUID of the category

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

the home glossary of the category

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getTermsOfCategory

@GetMapping("/categories/{categoryGUID}/terms")
public List<GlossaryTerm> getTermsOfCategory(@PathVariable
 String serverName,
 @PathVariable("categoryGUID")
 String categoryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

categoryGUID - GUID of the category

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of terms corresponding to the category

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend

getExternalGlossaryLinks

@GetMapping("/categories/{categoryGUID}/externalGlossaryLinks")
public List<ExternalGlossaryLink> getExternalGlossaryLinks(@PathVariable
 String serverName,
 @PathVariable("categoryGUID")
 String categoryGUID,
 @RequestParam(defaultValue="0")
 Integer from,
 @RequestParam(defaultValue="100")
 Integer size)
                                                    throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Deprecated.

Parameters:

serverName - name of the server to route the request to

categoryGUID - GUID of the category

from - the starting index, used for pagination

size - number of results returned, used for pagination

Returns:

list of a category's external glossary links

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if a problem occurs while serving the request

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if parameter validation fails

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if a problem occurs on the omas backend