Class GlossaryExchangeRESTServices
java.lang.Object
org.odpi.openmetadata.accessservices.assetmanager.server.GlossaryExchangeRESTServices
GlossaryExchangeRESTServices is the server-side implementation of the Asset Manager OMAS's
support for glossaries. It matches the GlossaryExchangeClient.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionarchiveGlossaryTerm
(String serverName, String userId, String glossaryTermGUID, boolean forDuplicateProcessing, ArchiveRequestBody requestBody) Archive the metadata element representing a glossary term.attachExternalCategoryLink
(String serverName, String userId, String glossaryCategoryGUID, String externalLinkGUID, boolean forLineage, boolean forDuplicateProcessing, ExternalGlossaryElementLinkRequestBody requestBody) Create a link to an external glossary category resource.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.attachExternalTermLink
(String serverName, String userId, String externalLinkGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ExternalGlossaryElementLinkRequestBody requestBody) Create a link to an external glossary term resource.clearCategoryParent
(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a parent-child relationship between two categories.clearGlossaryAsCanonical
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the canonical designation from the glossary.clearGlossaryAsEditingGlossary
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the editing glossary designation from the glossary.clearGlossaryAsStagingGlossary
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the staging glossary designation from the glossary.clearGlossaryAsTaxonomy
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the taxonomy designation from the glossary.clearTermAsAbstractConcept
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the abstract concept designation from the glossary term.clearTermAsActivity
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the activity designation from the glossary term.clearTermAsContext
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the context definition designation from the glossary term.clearTermAsDataField
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the data field designation from the glossary term.clearTermAsDataValue
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the data value designation from the glossary term.clearTermAsObjectIdentifier
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the object identifier designation from the glossary term.clearTermAsSpineAttribute
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the spine attribute designation from the glossary term.clearTermAsSpineObject
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the spine object designation from the glossary term.clearTermCategory
(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Unlink a term from a category.clearTermRelationship
(String serverName, String userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove the relationship between two terms.createControlledGlossaryTerm
(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, ControlledGlossaryTermRequestBody requestBody) Create a new metadata element to represent a glossary term whose lifecycle is managed through a controlled workflow.createExternalGlossaryLink
(String serverName, String userId, ExternalGlossaryLinkRequestBody requestBody) Create a link to an external glossary resource.createGlossary
(String serverName, String userId, boolean assetManagerIsHome, ReferenceableRequestBody requestBody) Create a new metadata element to represent the root of a glossary.createGlossaryCategory
(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean isRootCategory, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Create a new metadata element to represent a glossary category.createGlossaryCategoryFromTemplate
(String serverName, String userId, String glossaryGUID, String templateGUID, boolean assetManagerIsHome, boolean deepCopy, TemplateRequestBody requestBody) Create a new metadata element to represent a glossary category using an existing metadata element as a template.createGlossaryFromTemplate
(String serverName, String userId, boolean assetManagerIsHome, String templateGUID, boolean deepCopy, TemplateRequestBody requestBody) Create a new metadata element to represent a glossary using an existing metadata element as a template.createGlossaryTerm
(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Create a new metadata element to represent a glossary term.createGlossaryTermFromTemplate
(String serverName, String userId, String glossaryGUID, String templateGUID, boolean assetManagerIsHome, boolean deepCopy, boolean templateSubstitute, GlossaryTemplateRequestBody requestBody) Create a new metadata element to represent a glossary term using an existing metadata element as a template.detachExternalCategoryLink
(String serverName, String userId, String externalLinkGUID, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove the link to an external glossary category resource.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.detachExternalTermLink
(String serverName, String userId, String externalLinkGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove the link to an external glossary term resource.findGlossaries
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, SearchStringRequestBody requestBody) Retrieve the list of glossary metadata elements that contain the search string.findGlossaryCategories
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary category metadata elements that contain the search string.findGlossaryTerms
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody requestBody) Retrieve the list of glossary term metadata elements that contain the search string.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.getCategoriesForTerm
(String serverName, String userId, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary term.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.getGlossariesByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, NameRequestBody requestBody) Retrieve the list of glossary metadata elements with a matching qualified or display name.getGlossariesForAssetManager
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of glossaries created by this caller.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.getGlossaryByGUID
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element with the supplied unique identifier.getGlossaryCategoriesByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary category metadata elements with a matching qualified or display name.getGlossaryCategoryByGUID
(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.getGlossaryCategoryParent
(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary category metadata element with the supplied unique identifier.getGlossaryForCategory
(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested category.getGlossaryForTerm
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested term.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.getGlossaryTermByGUID
(String serverName, String userId, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary term metadata element with the supplied unique identifier.getGlossaryTermHistory
(String serverName, String userId, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryExternalIdentifiersRequestBody requestBody) Retrieve all the versions of a glossary term.getGlossaryTermsByName
(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody requestBody) Retrieve the list of glossary term metadata elements with a matching qualified or display name.getRelatedTerms
(String serverName, String userId, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with the requested glossary term.getTermRelationshipTypeNames
(String serverName, String userId) Return the list of term-to-term relationship names.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.getTermsForGlossaryCategory
(String serverName, String userId, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary category.moveGlossaryTerm
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Move a glossary term from one glossary to another.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).removeGlossary
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Remove the metadata element representing a glossary.removeGlossaryCategory
(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Remove the metadata element representing a glossary category.removeGlossaryTerm
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Remove the metadata element representing a glossary term.setGlossaryAsCanonical
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify a glossary to declare that it has no two GlossaryTerm definitions with the same name.setGlossaryAsEditingGlossary
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 another glossary.setGlossaryAsTaxonomy
(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary to indicate that it can be used as a taxonomy.setTermAsAbstractConcept
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an abstract concept.setTermAsActivity
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.setTermAsContext
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a context.setTermAsDataField
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.setTermAsDataValue
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.setTermAsObjectIdentifier
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an object identifier.setTermAsSpineAttribute
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a spine attribute.setTermAsSpineObject
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a spine object.setupCategoryParent
(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a parent-child relationship between two categories.setupTermCategory
(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link a term to a category.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.undoGlossaryTermUpdate
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Undo the last update to the glossary term.updateExternalGlossaryLink
(String serverName, String userId, String externalLinkGUID, boolean forLineage, boolean forDuplicateProcessing, ExternalGlossaryLinkRequestBody requestBody) Update the properties of a reference to an external glossary resource.updateGlossary
(String serverName, String userId, String glossaryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary.updateGlossaryCategory
(String serverName, String userId, String glossaryCategoryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary category.updateGlossaryTerm
(String serverName, String userId, String glossaryTermGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary term.updateGlossaryTermFromTemplate
(String serverName, String userId, String glossaryTermGUID, boolean isMergeClassifications, boolean isMergeProperties, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the glossary term using the properties and classifications from the parentGUID stored in the request body.updateGlossaryTermStatus
(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermStatusRequestBody requestBody) Update the status of the metadata element representing a glossary term.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.
-
Constructor Details
-
GlossaryExchangeRESTServices
public GlossaryExchangeRESTServices()Default constructor
-
-
Method Details
-
createGlossary
public GUIDResponse createGlossary(String serverName, String userId, boolean assetManagerIsHome, ReferenceableRequestBody 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 touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this elementrequestBody
- properties to store- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGlossaryFromTemplate
public GUIDResponse createGlossaryFromTemplate(String serverName, String userId, boolean assetManagerIsHome, String templateGUID, boolean deepCopy, 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 touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this elementtemplateGUID
- unique identifier of the metadata element to copydeepCopy
- should the template creation extend to the anchored elements or just the direct entity?requestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGlossary
public VoidResponse updateGlossary(String serverName, String userId, String glossaryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the properties be merged with the existing properties or completely over-write themforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- new properties for this element- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
removeGlossary
public VoidResponse removeGlossary(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody 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 touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- 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)
-
setGlossaryAsEditingGlossary
public VoidResponse setGlossaryAsEditingGlossary(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- 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)
-
clearGlossaryAsEditingGlossary
public VoidResponse clearGlossaryAsEditingGlossary(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the editing glossary designation from the glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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)
-
setGlossaryAsStagingGlossary
public VoidResponse setGlossaryAsStagingGlossary(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 another glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- 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)
-
clearGlossaryAsStagingGlossary
public VoidResponse clearGlossaryAsStagingGlossary(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the staging glossary designation from the glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?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)
-
setGlossaryAsTaxonomy
public VoidResponse setGlossaryAsTaxonomy(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- 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)
-
clearGlossaryAsTaxonomy
public VoidResponse clearGlossaryAsTaxonomy(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the taxonomy designation from the glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setGlossaryAsCanonical
public VoidResponse setGlossaryAsCanonical(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody 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 touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- description of the situations where this glossary is relevant.- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearGlossaryAsCanonical
public VoidResponse clearGlossaryAsCanonical(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the canonical designation from the glossary.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element to removeforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
findGlossaries
public GlossaryElementsResponse findGlossaries(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- string to find in the properties- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGlossariesByName
public GlossaryElementsResponse getGlossariesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- name to search for- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGlossariesForAssetManager
public GlossaryElementsResponse getGlossariesForAssetManager(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the list of glossaries created by this caller.- Parameters:
serverName
- name of the server to route the request touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGlossaryByGUID
public GlossaryElementResponse getGlossaryByGUID(String serverName, String userId, String glossaryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryForCategory
public GlossaryElementResponse getGlossaryForCategory(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryForTerm
public GlossaryElementResponse getGlossaryForTerm(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary metadata element for the requested term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the requested metadata elementforLineage
- 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)
-
createGlossaryCategory
public GUIDResponse createGlossaryCategory(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean isRootCategory, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Create a new metadata element to represent a glossary category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the glossary where the category is locatedassetManagerIsHome
- ensure that only the asset manager can update this elementisRootCategory
- is this category a root category?forLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties about the glossary category to store- Returns:
- unique identifier of the new glossary category or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGlossaryCategoryFromTemplate
public GUIDResponse createGlossaryCategoryFromTemplate(String serverName, String userId, String glossaryGUID, String templateGUID, boolean assetManagerIsHome, boolean deepCopy, 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 touserId
- calling userassetManagerIsHome
- ensure that only the asset manager can update this elementglossaryGUID
- unique identifier of the glossary where the category is locatedtemplateGUID
- unique identifier of the metadata element to copydeepCopy
- should the template creation extend to the anchored elements or just the direct entity?requestBody
- properties that override the template- Returns:
- unique identifier of the new glossary category or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGlossaryCategory
public VoidResponse updateGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the metadata element to updateisMergeUpdate
- should the new properties be merged with existing properties (true) or completely replace them (false)?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
public VoidResponse setupCategoryParent(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Create a parent-child relationship between two categories.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryParentCategoryGUID
- unique identifier of the glossary category in the external asset manager that is to be the super-categoryglossaryChildCategoryGUID
- unique identifier of the glossary category in the external asset manager that is to be the subcategoryforLineage
- 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
public VoidResponse clearCategoryParent(String serverName, String userId, String glossaryParentCategoryGUID, String glossaryChildCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove a parent-child relationship between two categories.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryParentCategoryGUID
- unique identifier of the glossary category in the external asset manager that is to be the super-categoryglossaryChildCategoryGUID
- unique identifier of the glossary category in the external asset manager that is to be the subcategoryforLineage
- 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
public VoidResponse removeGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Remove the metadata element representing a glossary category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the metadata element to removeforLineage
- 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
public GlossaryCategoryElementsResponse findGlossaryCategories(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the glossary to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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)
-
getCategoriesForTerm
public GlossaryCategoryElementsResponse getCategoriesForTerm(String serverName, String userId, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the list of categories associated with a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term to querystartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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 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)
-
getGlossaryCategoriesByName
public GlossaryCategoryElementsResponse getGlossaryCategoriesByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody 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 touserId
- calling userrequestBody
- name to search for and correlatorsstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the requested metadata elementforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the requested metadata elementstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public GUIDResponse createGlossaryTerm(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Create a new metadata element to represent a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the glossary where the term is locatedassetManagerIsHome
- ensure that only the asset manager can update this elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the glossary term- Returns:
- unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createControlledGlossaryTerm
public GUIDResponse createControlledGlossaryTerm(String serverName, String userId, String glossaryGUID, boolean assetManagerIsHome, boolean forLineage, boolean forDuplicateProcessing, 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 touserId
- calling userglossaryGUID
- unique identifier of the glossary where the term is locatedassetManagerIsHome
- ensure that only the asset manager can update this elementforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- properties for the glossary term- Returns:
- unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
createGlossaryTermFromTemplate
public GUIDResponse createGlossaryTermFromTemplate(String serverName, String userId, String glossaryGUID, String templateGUID, boolean assetManagerIsHome, boolean deepCopy, boolean templateSubstitute, GlossaryTemplateRequestBody 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 touserId
- calling userglossaryGUID
- unique identifier of the glossary where the term is locatedassetManagerIsHome
- ensure that only the asset manager can update this elementtemplateGUID
- unique identifier of the metadata element to copydeepCopy
- should the template creation extend to the anchored elements or just the direct entity?templateSubstitute
- is this element a template substitute (used as the "other end" of a new/updated relationship)requestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element for the glossary term or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateGlossaryTerm
public VoidResponse updateGlossaryTerm(String serverName, String userId, String glossaryTermGUID, boolean isMergeUpdate, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Update the metadata element representing a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term to updateisMergeUpdate
- should the properties be merged with the existing properties or completely over-write themforLineage
- 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
public 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. This is only valid on a controlled glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term to updateforLineage
- 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)
-
updateGlossaryTermFromTemplate
public VoidResponse updateGlossaryTermFromTemplate(String serverName, String userId, String glossaryTermGUID, boolean isMergeClassifications, boolean isMergeProperties, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody 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 touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term to updateisMergeClassifications
- should the classification be merged or replace the target entity?isMergeProperties
- should the properties be merged with the existing ones or replace themforLineage
- 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)
-
moveGlossaryTerm
public VoidResponse moveGlossaryTerm(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Move a glossary term from one glossary to another.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term to updateforLineage
- 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
public VoidResponse setupTermCategory(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link a term to a category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the glossary categoryglossaryTermGUID
- unique identifier of the glossary termforLineage
- 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
public VoidResponse clearTermCategory(String serverName, String userId, String glossaryCategoryGUID, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Unlink a term from a category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the glossary categoryglossaryTermGUID
- unique identifier of the glossary termforLineage
- 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)
-
getTermRelationshipTypeNames
Return the list of term-to-term relationship names.- Parameters:
serverName
- name of the server instance to connect touserId
- calling user- 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 userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, RelationshipRequestBody requestBody) Link two terms together using a specialist relationship.- Parameters:
serverName
- name of the server to route the request touserId
- calling userrelationshipTypeName
- 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 2forLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userrelationshipTypeName
- 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 2forLineage
- 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
public VoidResponse clearTermRelationship(String serverName, String userId, String glossaryTermOneGUID, String relationshipTypeName, String glossaryTermTwoGUID, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Remove the relationship between two terms.- Parameters:
serverName
- name of the server to route the request touserId
- calling userrelationshipTypeName
- 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 2forLineage
- 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
public VoidResponse setTermAsAbstractConcept(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an abstract concept.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsAbstractConcept(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the abstract concept designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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)
-
setTermAsDataField
public VoidResponse setTermAsDataField(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data field and supply properties that describe the characteristics of the data values found within.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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)
-
clearTermAsDataField
public VoidResponse clearTermAsDataField(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the data field designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsDataValue(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsDataValue(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the data value designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsActivity(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a data value.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsActivity(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the activity designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsContext(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a context.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsContext(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the context definition designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsSpineObject(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a spine object.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsSpineObject(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the spine object designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsSpineAttribute(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes a spine attribute.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsSpineAttribute(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the spine attribute designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse setTermAsObjectIdentifier(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Classify the glossary term to indicate that it describes an object identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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
public VoidResponse clearTermAsObjectIdentifier(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ClassificationRequestBody requestBody) Remove the object identifier designation from the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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)
-
undoGlossaryTermUpdate
public GlossaryTermElementResponse undoGlossaryTermUpdate(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, UpdateRequestBody requestBody) Undo the last update to the glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to updateforLineage
- 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)
-
archiveGlossaryTerm
public VoidResponse archiveGlossaryTerm(String serverName, String userId, String glossaryTermGUID, boolean forDuplicateProcessing, ArchiveRequestBody requestBody) Archive the metadata element representing a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to archiveforDuplicateProcessing
- 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
public VoidResponse removeGlossaryTerm(String serverName, String userId, String glossaryTermGUID, boolean forLineage, boolean forDuplicateProcessing, ReferenceableUpdateRequestBody requestBody) Remove the metadata element representing a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the metadata element to removeforLineage
- 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
public GlossaryTermElementsResponse findGlossaryTerms(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossarySearchStringRequestBody 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the glossary of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public GlossaryTermElementsResponse getTermsForGlossaryCategory(String serverName, String userId, String glossaryCategoryGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with a glossary category.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryCategoryGUID
- unique identifier of the glossary category of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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)
-
getRelatedTerms
public GlossaryTermElementsResponse getRelatedTerms(String serverName, String userId, String glossaryTermGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryTermRelationshipRequestBody requestBody) Retrieve the list of glossary terms associated with the requested glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryTermGUID
- unique identifier of the glossary term of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public GlossaryTermElementsResponse getGlossaryTermsByName(String serverName, String userId, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, GlossaryNameRequestBody 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 touserId
- calling userstartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public GlossaryTermElementResponse getGlossaryTermByGUID(String serverName, String userId, String guid, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Retrieve the glossary term metadata element with the supplied unique identifier.- Parameters:
serverName
- name of the server to route the request touserId
- calling userguid
- unique identifier of the requested metadata elementforLineage
- 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)
-
getGlossaryTermHistory
public GlossaryTermElementsResponse getGlossaryTermHistory(String serverName, String userId, String guid, int startFrom, int pageSize, boolean oldestFirst, boolean forLineage, boolean forDuplicateProcessing, HistoryExternalIdentifiersRequestBody requestBody) Retrieve all the versions of a glossary term.- Parameters:
serverName
- name of the server to route the request touserId
- calling userguid
- unique identifier of object to retrievestartFrom
- the starting element number of the historical versions to return. This is used when retrieving versions beyond the first page of results. Zero means start from the first element.pageSize
- the maximum number of result versions that can be returned on this request. Zero means unrestricted return results size.oldestFirst
- defining how the results should be ordered.forLineage
- the request is to support lineage retrieval this means entities with the Memento classification can be returnedforDuplicateProcessing
- the request is for duplicate processing and so must not deduplicaterequestBody
- the time that the retrieved elements must be effective for (null for any time, new Date() for now)- Returns:
- list of beans or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem removing the properties from the repositories. UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createExternalGlossaryLink
public GUIDResponse createExternalGlossaryLink(String serverName, String userId, ExternalGlossaryLinkRequestBody requestBody) Create a link to an external glossary resource. This is associated with a glossary to show that they have equivalent content. It is possible that this resource was generated from the glossary content or was the source for it.- Parameters:
serverName
- name of the server to route the request touserId
- calling userrequestBody
- properties of the link- Returns:
- unique identifier of the external reference or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateExternalGlossaryLink
public VoidResponse updateExternalGlossaryLink(String serverName, String userId, String externalLinkGUID, boolean forLineage, boolean forDuplicateProcessing, ExternalGlossaryLinkRequestBody requestBody) Update the properties of a reference to an external glossary resource.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceforLineage
- 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
public 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).- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryGUID
- unique identifier of the metadata element to attachforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryGUID
- unique identifier of the metadata element to removeforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userglossaryGUID
- unique identifier of the metadata element for the glossary of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- return elements marked with the Memento classification?forDuplicateProcessing
- do not merge elements marked as duplicates?requestBody
- asset manager identifiers- Returns:
- list of attached links to external glossary resources or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
getGlossariesForExternalLink
public GlossaryElementsResponse getGlossariesForExternalLink(String serverName, String userId, String externalLinkGUID, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, EffectiveTimeQueryRequestBody requestBody) Return the glossaries connected to an external glossary source.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the metadata element for the external glossary link of intereststartFrom
- paging start pointpageSize
- maximum results that can be returnedforLineage
- 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
public 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. 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 touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryCategoryGUID
- unique identifier for the glossary categoryforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryCategoryGUID
- unique identifier for the glossary categoryforLineage
- 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
public 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. 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 touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryTermGUID
- unique identifier for the glossary categoryforLineage
- 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
public 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.- Parameters:
serverName
- name of the server to route the request touserId
- calling userexternalLinkGUID
- unique identifier of the external referenceglossaryTermGUID
- unique identifier for the glossary categoryforLineage
- 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)
-