Class GlossaryManagerRESTServices
java.lang.Object
org.odpi.openmetadata.tokencontroller.TokenController
org.odpi.openmetadata.viewservices.glossarymanager.server.GlossaryManagerRESTServices
The GlossaryManagerRESTServices provides the implementation of the Glossary ManagerOpen Metadata View Service (OMVS).
This interface provides view interfaces for infrastructure and ops users.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclearGlossaryAsCanonical
(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the canonical designation from the glossary.clearGlossaryAsEditingGlossary
(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the editing glossary designation from the glossary.clearGlossaryAsStagingGlossary
(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the staging glossary designation from the glossary.clearGlossaryAsTaxonomy
(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the taxonomy designation from the glossary.clearTermAsAbstractConcept
(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the abstract concept designation from the glossary term.clearTermAsActivity
(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the activity designation from the glossary term.clearTermAsContext
(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the context definition designation from the glossary term.clearTermAsDataValue
(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the data value designation from the glossary term.clearTermRelationship
(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, DeleteRequestBody requestBody) Remove the relationship between two terms.createGlossary
(String serverName, NewElementRequestBody requestBody) Create a new metadata element to represent the root of a glossary.createGlossaryFromTemplate
(String serverName, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a glossary using an existing metadata element as a template.createGlossaryTerm
(String serverName, NewElementRequestBody requestBody) Create a new metadata element to represent a glossary term using an existing metadata element as a template.createGlossaryTermFromTemplate
(String serverName, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a glossary term using an existing metadata element as a template.deleteGlossary
(String serverName, String glossaryGUID, DeleteRequestBody requestBody) Remove the metadata element representing a glossary.deleteGlossaryTerm
(String serverName, String glossaryTermGUID, DeleteRequestBody requestBody) Remove the metadata element representing a glossary term.getGlossaryTermActivityTypes
(String serverName) Return the list of glossary term relationship status enum values.getGlossaryTermRelationshipStatuses
(String serverName) Return the list of glossary term relationship status enum values.getGlossaryTermStatuses
(String serverName) Return the list of glossary term status enum values.getTermRelationshipTypeNames
(String serverName) Return the list of term-to-term relationship names.moveGlossaryTerm
(String serverName, String glossaryTermGUID, String glossaryGUID, DeleteRequestBody requestBody) Move a glossary term from one glossary to another.setGlossaryAsCanonical
(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.setGlossaryAsEditingGlossary
(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.setGlossaryAsStagingGlossary
(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify the glossary to indicate that it is a staging glossary - this means it is a collection of glossary updates that will be transferred into another glossary.setGlossaryAsTaxonomy
(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify the glossary to indicate that it can be used as a taxonomy.setTermAsAbstractConcept
(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an abstract concept.setTermAsActivity
(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.setTermAsContext
(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a context.setTermAsDataValue
(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.setupTermRelationship
(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, NewRelationshipRequestBody requestBody) Link two terms together using a specialist relationship.updateGlossary
(String serverName, String glossaryGUID, UpdateElementRequestBody requestBody) Update the metadata element representing a glossary.updateGlossaryTerm
(String serverName, String glossaryTermGUID, UpdateElementRequestBody requestBody) Update the metadata element representing a glossary term.updateGlossaryTermFromTemplate
(String serverName, String glossaryTermGUID, String templateGUID, UpdateWithTemplateRequestBody requestBody) Update the glossary term using the properties and classifications from the parentGUID stored in the request body.updateTermRelationship
(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, UpdateRelationshipRequestBody requestBody) Update the relationship properties for the two terms.Methods inherited from class org.odpi.openmetadata.tokencontroller.TokenController
getUser
-
Constructor Details
-
GlossaryManagerRESTServices
public GlossaryManagerRESTServices()Default constructor
-
-
Method Details
-
createGlossary
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 torequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGlossaryFromTemplate
public GUIDResponse createGlossaryFromTemplate(String serverName, String templateGUID, 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 totemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGlossary
public VoidResponse updateGlossary(String serverName, String glossaryGUID, UpdateElementRequestBody requestBody) Update the metadata element representing a glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to updaterequestBody
- 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)
-
deleteGlossary
public VoidResponse deleteGlossary(String serverName, String glossaryGUID, DeleteRequestBody 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 toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setGlossaryAsEditingGlossary
public VoidResponse setGlossaryAsEditingGlossary(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify the glossary to indicate that it is an editing glossary - this means it is a collection of glossary updates that will be merged into its source glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearGlossaryAsEditingGlossary
public VoidResponse clearGlossaryAsEditingGlossary(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the editing glossary designation from the glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setGlossaryAsStagingGlossary
public VoidResponse setGlossaryAsStagingGlossary(String serverName, String glossaryGUID, NewClassificationRequestBody requestBody) Classify the glossary to indicate that it is a staging glossary - this means it is a collection of glossary updates that will be transferred into another glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearGlossaryAsStagingGlossary
public VoidResponse clearGlossaryAsStagingGlossary(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the staging glossary designation from the glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setGlossaryAsTaxonomy
public VoidResponse setGlossaryAsTaxonomy(String serverName, String glossaryGUID, NewClassificationRequestBody 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 toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearGlossaryAsTaxonomy
public VoidResponse clearGlossaryAsTaxonomy(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the taxonomy designation from the glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setGlossaryAsCanonical
public VoidResponse setGlossaryAsCanonical(String serverName, String glossaryGUID, NewClassificationRequestBody 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 toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- description of the situations where this glossary is relevant.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearGlossaryAsCanonical
public VoidResponse clearGlossaryAsCanonical(String serverName, String glossaryGUID, MetadataSourceRequestBody requestBody) Remove the canonical designation from the glossary.- Parameters:
serverName
- name of the server to route the request toglossaryGUID
- unique identifier of the metadata element to removerequestBody
- 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)
-
getGlossaryTermStatuses
Return the list of glossary term status enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
getGlossaryTermRelationshipStatuses
public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(String serverName) Return the list of glossary term relationship status enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
getGlossaryTermActivityTypes
Return the list of glossary term relationship status enum values.- Parameters:
serverName
- name of the server to route the request to- Returns:
- list of enum values
-
createGlossaryTerm
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 torequestBody
- 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)
-
createGlossaryTermFromTemplate
public GUIDResponse createGlossaryTermFromTemplate(String serverName, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a glossary term using an existing metadata element as a template.- Parameters:
serverName
- name of the server to route the request totemplateGUID
- unique identifier of the metadata element to copyrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGlossaryTerm
public VoidResponse updateGlossaryTerm(String serverName, String glossaryTermGUID, UpdateElementRequestBody requestBody) Update the metadata element representing a glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the glossary term to updaterequestBody
- 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)
-
updateGlossaryTermFromTemplate
public VoidResponse updateGlossaryTermFromTemplate(String serverName, String glossaryTermGUID, String templateGUID, UpdateWithTemplateRequestBody requestBody) Update the glossary term using the properties and classifications from the parentGUID stored in the request body.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the glossary term to updatetemplateGUID
- template to userequestBody
- status and correlation properties- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
moveGlossaryTerm
public VoidResponse moveGlossaryTerm(String serverName, String glossaryTermGUID, String glossaryGUID, DeleteRequestBody requestBody) Move a glossary term from one glossary to another.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the glossary term to updaterequestBody
- 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)
-
getTermRelationshipTypeNames
Return the list of term-to-term relationship names.- Parameters:
serverName
- name of the server instance to connect to- Returns:
- list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.
-
setupTermRelationship
public VoidResponse setupTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, NewRelationshipRequestBody requestBody) Link two terms together using a specialist relationship.- Parameters:
serverName
- name of the server to route the request torelationshipTypeName
- name of the type of relationship to createglossaryTermOneGUID
- unique identifier of the glossary term at end 1glossaryTermTwoGUID
- unique identifier of the glossary term at end 2requestBody
- properties for the relationship- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateTermRelationship
public VoidResponse updateTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, UpdateRelationshipRequestBody requestBody) Update the relationship properties for the two terms.- Parameters:
serverName
- name of the server to route the request torelationshipTypeName
- name of the type of relationship to createglossaryTermOneGUID
- unique identifier of the glossary term at end 1glossaryTermTwoGUID
- unique identifier of the glossary term at end 2requestBody
- properties for the relationship- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearTermRelationship
public VoidResponse clearTermRelationship(String serverName, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, DeleteRequestBody requestBody) Remove the relationship between two terms.- Parameters:
serverName
- name of the server to route the request torelationshipTypeName
- name of the type of relationship to createglossaryTermOneGUID
- unique identifier of the glossary term at end 1glossaryTermTwoGUID
- unique identifier of the glossary term at end 2requestBody
- properties of the relationship- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setTermAsAbstractConcept
public VoidResponse setTermAsAbstractConcept(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an abstract concept.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearTermAsAbstractConcept
public VoidResponse clearTermAsAbstractConcept(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the abstract concept designation from the glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setTermAsDataValue
public VoidResponse setTermAsDataValue(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearTermAsDataValue
public VoidResponse clearTermAsDataValue(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the data value designation from the glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setTermAsActivity
public VoidResponse setTermAsActivity(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- type of activity and correlators- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearTermAsActivity
public VoidResponse clearTermAsActivity(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the activity designation from the glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setTermAsContext
public VoidResponse setTermAsContext(String serverName, String glossaryTermGUID, NewClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a context.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- more details of the context- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearTermAsContext
public VoidResponse clearTermAsContext(String serverName, String glossaryTermGUID, MetadataSourceRequestBody requestBody) Remove the context definition designation from the glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to updaterequestBody
- 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)
-
deleteGlossaryTerm
public VoidResponse deleteGlossaryTerm(String serverName, String glossaryTermGUID, DeleteRequestBody requestBody) Remove the metadata element representing a glossary term.- Parameters:
serverName
- name of the server to route the request toglossaryTermGUID
- unique identifier of the metadata element to removerequestBody
- 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)
-