SubjectAreaRelationship (Subject Area OMAS Client 2.0 API)

All Known Implementing Classes:

SubjectAreaRelationshipImpl
```
public interface SubjectAreaRelationship
```
The SubjectAreaDefinition Open Metadata Access Service (OMAS) API for relationships.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Antonym`	`createAntonymRelationship(String userId, Antonym antonym)` Create a antonym relationship.
`CategoryAnchor`	`createCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Create a Category Anchor Relationship.
`Isa`	`createIsaRelationship(String userId, Isa isa)` Create a Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`createPreferredTermRelationship(String userId, PreferredTerm preferredTerm)` Create a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`createProjectScopeRelationship(String userId, ProjectScope projectScope)` Create a ProjectScope relationship.
`RelatedTerm`	`createRelatedTerm(String userId, RelatedTerm relatedTermRelationship)` Create a RelatedTerm.
`ReplacementTerm`	`createReplacementTermRelationship(String userId, ReplacementTerm replacementTerm)` Create a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`createSynonymRelationship(String userId, Synonym synonym)` Create a synonym relationship.
`TermAnchor`	`createTermAnchorRelationship(String userId, TermAnchor termAnchorRelationship)` Create a Term Anchor Relationship.
`Categorization`	`createTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Create a Term Categorization Relationship.
`Hasa`	`createTermHASARelationship(String userId, Hasa termHASARelationship)` Create a Term HASA Relationship.
`IsaTypeOf`	`createTermISATypeOFRelationship(String userId, IsaTypeOf TermISATypeOFRelationship)` Create a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`createTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Create a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`createTranslationRelationship(String userId, Translation translation)` Create a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`createUsedInContextRelationship(String userId, UsedInContext usedInContext)` Create a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`ValidValue`	`createValidValueRelationship(String userId, ValidValue validValue)` Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`deleteAntonymRelationship(String userId, String guid)` Delete a antonym relationship.
`CategoryAnchor`	`deleteCategoryAnchorRelationship(String userId, String guid)` Delete a Category Anchor Relationship.
`Isa`	`deleteIsaRelationship(String userId, String guid)` Delete a isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`deletePreferredTermRelationship(String userId, String guid)` Delete a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`deleteProjectScopeRelationship(String userId, String guid)` Delete a ProjectScope relationship.
`RelatedTerm`	`deleteRelatedTerm(String userId, String guid)` Delete a RelatedTerm.
`ReplacementTerm`	`deleteReplacementTermRelationship(String userId, String guid)` Delete a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`deleteSynonymRelationship(String userId, String guid)` Delete a synonym relationship.
`TermAnchor`	`deleteTermAnchorRelationship(String userId, String guid)` Delete a Term Anchor Relationship.
`Categorization`	`deleteTermCategorizationRelationship(String userId, String guid)` Delete a Term Categorization Relationship.
`Hasa`	`deleteTermHASARelationship(String userId, String guid)` Delete a Term HASA Relationship.
`IsaTypeOf`	`deleteTermISATypeOFRelationship(String userId, String guid)` Delete a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`deleteTermTYPEDBYRelationship(String userId, String guid)` Delete a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`deleteTranslationRelationship(String userId, String guid)` Delete a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`deleteUsedInContextRelationship(String userId, String guid)` Delete a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`ValidValue`	`deleteValidValueRelationship(String userId, String guid)` Delete a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`getAntonymRelationship(String userId, String guid)` Get a antonym relationship.
`CategoryAnchor`	`getCategoryAnchorRelationship(String userId, String guid)` Get a Category Anchor Relationship.
`Isa`	`getIsaRelationship(String userId, String guid)` Get a isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`getPreferredTermRelationship(String userId, String guid)` Get a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`getProjectScopeRelationship(String userId, String guid)` Get a ProjectScope relationship.
`RelatedTerm`	`getRelatedTerm(String userId, String guid)` Get a RelatedTerm.
`ReplacementTerm`	`getReplacementTermRelationship(String userId, String guid)` Get a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`SemanticAssignment`	`getSemanticAssignmentRelationship(String userId, String guid)` Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
`Synonym`	`getSynonymRelationship(String userId, String guid)` Get a synonym relationship.
`TermAnchor`	`getTermAnchorRelationship(String userId, String guid)` Get a Term Anchor Relationship.
`Categorization`	`getTermCategorizationRelationship(String userId, String guid)` Get a Term Categorization Relationship.
`Hasa`	`getTermHASARelationship(String userId, String guid)` Get a Term HASA Relationship.
`IsaTypeOf`	`getTermISATypeOFRelationship(String userId, String guid)` Get a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`getTermTYPEDBYRelationship(String userId, String guid)` Get a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`getTranslationRelationship(String userId, String guid)` Get a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`getUsedInContextRelationship(String userId, String guid)` Get a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`ValidValue`	`getValidValueRelationship(String userId, String guid)` Get a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`void`	`purgeAntonymRelationship(String userId, String guid)` Purge a antonym relationship.
`void`	`purgeCategoryAnchorRelationship(String userId, String guid)` Purge a Category Anchor Relationship.
`void`	`purgeIsaRelationship(String userId, String guid)` Purge a isa relationship, which is link between a more general glossary term and a more specific definition.
`void`	`purgePreferredTermRelationship(String userId, String guid)` Purge a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`void`	`purgeProjectScopeRelationship(String userId, String guid)` Purge a ProjectScope relationship.
`void`	`purgeRelatedTerm(String userId, String guid)` Purge a RelatedTerm.
`void`	`purgeReplacementTermRelationship(String userId, String guid)` Purge a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`void`	`purgeSynonymRelationship(String userId, String guid)` Purge a synonym relationship.
`void`	`purgeTermAnchorRelationship(String userId, String guid)` Purge a Term Anchor Relationship.
`void`	`purgeTermCategorizationRelationship(String userId, String guid)` Purge a Term Categorization Relationship.
`void`	`purgeTermHASARelationship(String userId, String guid)` Purge a Term HASA Relationship.
`void`	`purgeTermISATypeOFRelationship(String userId, String guid)` Purge a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`void`	`purgeTermTYPEDBYRelationship(String userId, String guid)` Purge a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
`void`	`purgeTranslationRelationship(String userId, String guid)` Purge a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`void`	`purgeUsedInContextRelationship(String userId, String guid)` Purge a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`void`	`purgeValidValueRelationship(String userId, String guid)` Purge a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`replaceAntonymRelationship(String userId, Antonym antonymRelationship)` Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchor`	`replaceCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Replace a Category Anchor Relationship.
`Isa`	`replaceIsaRelationship(String userId, Isa isaRelationship)` Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`replacePreferredTermRelationship(String userId, PreferredTerm preferredTermRelationship)` Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`replaceProjectScopeRelationship(String userId, ProjectScope projectScopeRelationship)` Replace a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`replaceRelatedTerm(String userId, RelatedTerm termRelatedTerm)` Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`ReplacementTerm`	`replaceReplacementTermRelationship(String userId, ReplacementTerm replacementTermRelationship)` Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`replaceSynonymRelationship(String userId, Synonym synonymRelationship)` Replace a Synonym relationship which is a link between glossary terms that have the same meaning
`TermAnchor`	`replaceTermAnchorRelationship(String userId, TermAnchor termAnchorRelationship)` Replace a Term HASA Relationship.
`Categorization`	`replaceTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Replace a Term HASA Relationship.
`Hasa`	`replaceTermHASARelationship(String userId, Hasa termHASARelationship)` Replace a Term HASA Relationship.
`IsaTypeOf`	`replaceTermISATypeOFRelationship(String userId, IsaTypeOf isATypeOf)` Replace an isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`replaceTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Replace an TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`replaceTranslationRelationship(String userId, Translation translationRelationship)` Replace an Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`replaceUsedInContextRelationship(String userId, UsedInContext usedInContextRelationship)` Replace an UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`ValidValue`	`replaceValidValueRelationship(String userId, ValidValue validValueRelationship)` Replace an ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`Antonym`	`restoreAntonymRelationship(String userId, String guid)` Restore a Antonym relationship Restore allows the deleted Antonym relationship to be made active again.
`CategoryAnchor`	`restoreCategoryAnchorRelationship(String userId, String guid)` Restore a Category Anchor Relationship.
`Isa`	`restoreIsaRelationship(String userId, String guid)` Restore an is a relationship Restore allows the deleted is a relationship to be made active again.
`IsaTypeOf`	`restoreIsaTypeOfRelationship(String userId, String guid)` Restore an is a type of relationship Restore allows the deleted is a type of relationship to be made active again.
`PreferredTerm`	`restorePreferredTermRelationship(String userId, String guid)` Restore a preferred term relationship Restore allows the deleted preferred term relationship to be made active again.
`ProjectScope`	`restoreProjectScopeRelationship(String userId, String guid)` Restore a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`restoreRelatedTerm(String userId, String guid)` Restore a Related Term relationship Restore allows the deleted Related Term relationship to be made active again.
`ReplacementTerm`	`restoreReplacementTermRelationship(String userId, String guid)` Restore a replacement term relationship Restore allows the deleted replacement term relationship to be made active again.
`Synonym`	`restoreSynonymRelationship(String userId, String guid)` Restore a Synonym relationship Restore allows the deleted Synonym relationship to be made active again.
`TermAnchor`	`restoreTermAnchorRelationship(String userId, String guid)` Restore a Term Anchor Relationship.
`Categorization`	`restoreTermCategorizationRelationship(String userId, String guid)` Restore a Term Categorization Relationship.
`Hasa`	`restoreTermHASARelationship(String userId, String guid)` Restore a has a relationship Restore allows the deleted has a relationship to be made active again.
`Translation`	`restoreTranslationRelationship(String userId, String guid)` Restore a Translation relationship Restore allows the deleted Translation relationship to be made active again.
`TypedBy`	`restoreTypedByRelationship(String userId, String guid)` Restore a typed by relationship Restore allows the deleted typed by relationship to be made active again.
`UsedInContext`	`restoreUsedInContextRelationship(String userId, String guid)` Restore a Used in context relationship Restore allows the deleted Used in context relationship to be made active again.
`ValidValue`	`restoreValidValueRelationship(String userId, String guid)` Restore a valid value relationship Restore allows the deleted valid value relationship to be made active again.
`Antonym`	`updateAntonymRelationship(String userId, Antonym antonymRelationship)` Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`CategoryAnchor`	`updateCategoryAnchorRelationship(String userId, CategoryAnchor categoryAnchorRelationship)` Update a Category Anchor Relationship.
`Isa`	`updateIsaRelationship(String userId, Isa isaRelationship)` Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
`PreferredTerm`	`updatePreferredTermRelationship(String userId, PreferredTerm preferredTermRelationship)` Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
`ProjectScope`	`updateProjectScopeRelationship(String userId, ProjectScope projectScopeRelationship)` Update a ProjectScope relationship which is a link between the project content and the project.
`RelatedTerm`	`updateRelatedTerm(String userId, RelatedTerm termRelatedTerm)` Update a RelatedTerm Relationship.
`ReplacementTerm`	`updateReplacementTermRelationship(String userId, ReplacementTerm replacementTermRelationship)` Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
`Synonym`	`updateSynonymRelationship(String userId, Synonym synonymRelationship)` Update a Synonym relationship which is a link between glossary terms that have the same meaning
`Categorization`	`updateTermCategorizationRelationship(String userId, Categorization termCategorizationRelationship)` Update a Term Categorization Relationship.
`Hasa`	`updateTermHASARelationship(String userId, Hasa termHASARelationship)` Update a Term HASA Relationship.
`IsaTypeOf`	`updateTermISATypeOFRelationship(String userId, IsaTypeOf isATypeOf)` Update a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
`TypedBy`	`updateTermTYPEDBYRelationship(String userId, TypedBy termTYPEDBYRelationship)` Update a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
`Translation`	`updateTranslationRelationship(String userId, Translation translationRelationship)` Update a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
`UsedInContext`	`updateUsedInContextRelationship(String userId, UsedInContext usedInContextRelationship)` Update a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
`ValidValue`	`updateValidValueRelationship(String userId, ValidValue validValueRelationship)` Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

- Method Detail
  - createTermHASARelationship
```
Hasa createTermHASARelationship(String userId,
                                Hasa termHASARelationship)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                MetadataServerUncontactableException,
                                UnexpectedResponseException,
                                UnrecognizedGUIDException,
                                PropertyServerException,
                                FunctionNotSupportedException
```
    Create a Term HASA Relationship. A relationship between a spine object and a spine attribute. Note that this method does not error if the relationship ends are not spine objects or spine attributes.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the created term HASA relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermHASARelationship
```
Hasa getTermHASARelationship(String userId,
                             String guid)
                      throws InvalidParameterException,
                             MetadataServerUncontactableException,
                             UserNotAuthorizedException,
                             UnexpectedResponseException,
                             UnrecognizedGUIDException,
                             PropertyServerException,
                             FunctionNotSupportedException
```
    Get a Term HASA Relationship. A relationship between a spine object and a spine attribute.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Hasa relationship to get
    
    Returns:
    
    Hasa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermHASARelationship
```
Hasa updateTermHASARelationship(String userId,
                                Hasa termHASARelationship)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                MetadataServerUncontactableException,
                                UnexpectedResponseException,
                                UnrecognizedGUIDException,
                                PropertyServerException,
                                FunctionNotSupportedException
```
    Update a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the updated term HASA relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermHASARelationship
```
Hasa replaceTermHASARelationship(String userId,
                                 Hasa termHASARelationship)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException,
                                 UnrecognizedGUIDException,
                                 PropertyServerException,
                                 FunctionNotSupportedException
```
    Replace a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termHASARelationship - the HASA relationship
    
    Returns:
    
    the replaced term HASA relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermHASARelationship
```
Hasa deleteTermHASARelationship(String userId,
                                String guid)
                         throws InvalidParameterException,
                                MetadataServerUncontactableException,
                                UserNotAuthorizedException,
                                UnrecognizedGUIDException,
                                FunctionNotSupportedException,
                                RelationshipNotDeletedException,
                                UnexpectedResponseException,
                                PropertyServerException
```
    Delete a Term HASA Relationship. A relationship between a spine object and a spine attribute. * A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Hasa relationship to delete
    
    Returns:
    
    Deleted Hasa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermHASARelationship
```
void purgeTermHASARelationship(String userId,
                               String guid)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               UnrecognizedGUIDException,
                               MetadataServerUncontactableException,
                               UnexpectedResponseException,
                               RelationshipNotPurgedException,
                               FunctionNotSupportedException,
                               PropertyServerException
```
    Purge a Term HASA Relationship. A relationship between a spine object and a spine attribute. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Hasa relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermHASARelationship
```
Hasa restoreTermHASARelationship(String userId,
                                 String guid)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException,
                                 UnrecognizedGUIDException,
                                 PropertyServerException,
                                 FunctionNotSupportedException
```
    Restore a has a relationship Restore allows the deleted has a relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the has a relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createRelatedTerm
```
RelatedTerm createRelatedTerm(String userId,
                              RelatedTerm relatedTermRelationship)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              MetadataServerUncontactableException,
                              UnexpectedResponseException,
                              UnrecognizedGUIDException,
                              PropertyServerException,
                              FunctionNotSupportedException
```
    Create a RelatedTerm. A Related Term is a link between two similar Terms.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    relatedTermRelationship - the RelatedTerm relationship
    
    Returns:
    
    the created RelatedTerm relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getRelatedTerm
```
RelatedTerm getRelatedTerm(String userId,
                           String guid)
                    throws InvalidParameterException,
                           MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           UnexpectedResponseException,
                           UnrecognizedGUIDException,
                           PropertyServerException,
                           FunctionNotSupportedException
```
    Get a RelatedTerm. A Related Term is a link between two similar Terms.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    RelatedTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateRelatedTerm
```
RelatedTerm updateRelatedTerm(String userId,
                              RelatedTerm termRelatedTerm)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              MetadataServerUncontactableException,
                              UnexpectedResponseException,
                              UnrecognizedGUIDException,
                              PropertyServerException,
                              FunctionNotSupportedException
```
    Update a RelatedTerm Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termRelatedTerm - the RelatedTerm relationship
    
    Returns:
    
    the updated term RelatedTerm relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceRelatedTerm
```
RelatedTerm replaceRelatedTerm(String userId,
                               RelatedTerm termRelatedTerm)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               MetadataServerUncontactableException,
                               UnexpectedResponseException,
                               UnrecognizedGUIDException,
                               PropertyServerException,
                               FunctionNotSupportedException
```
    Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termRelatedTerm - the replacement related term relationship
    
    Returns:
    
    ReplacementTerm replaced related Term relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreRelatedTerm
```
RelatedTerm restoreRelatedTerm(String userId,
                               String guid)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               MetadataServerUncontactableException,
                               UnexpectedResponseException,
                               UnrecognizedGUIDException,
                               PropertyServerException,
                               FunctionNotSupportedException
```
    Restore a Related Term relationship Restore allows the deleted Related Term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the related term relationship to restore
    
    Returns:
    
    response which when successful contains the restored related term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteRelatedTerm
```
RelatedTerm deleteRelatedTerm(String userId,
                              String guid)
                       throws InvalidParameterException,
                              MetadataServerUncontactableException,
                              UserNotAuthorizedException,
                              UnrecognizedGUIDException,
                              FunctionNotSupportedException,
                              RelationshipNotDeletedException,
                              UnexpectedResponseException,
                              PropertyServerException
```
    Delete a RelatedTerm. A Related Term is a link between two similar Terms. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted RelatedTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeRelatedTerm
```
void purgeRelatedTerm(String userId,
                      String guid)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      UnrecognizedGUIDException,
                      MetadataServerUncontactableException,
                      UnexpectedResponseException,
                      RelationshipNotPurgedException,
                      PropertyServerException,
                      FunctionNotSupportedException
```
    Purge a RelatedTerm. A Related Term is a link between two similar Terms. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createSynonymRelationship
```
Synonym createSynonymRelationship(String userId,
                                  Synonym synonym)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  MetadataServerUncontactableException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Create a synonym relationship. A link between glossary terms that have the same meaning.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonym - the Synonym relationship
    
    Returns:
    
    the created Synonym relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getSynonymRelationship
```
Synonym getSynonymRelationship(String userId,
                               String guid)
                        throws InvalidParameterException,
                               MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               UnexpectedResponseException,
                               UnrecognizedGUIDException,
                               PropertyServerException,
                               FunctionNotSupportedException
```
    Get a synonym relationship. A link between glossary terms that have the same meaning.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Synonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateSynonymRelationship
```
Synonym updateSynonymRelationship(String userId,
                                  Synonym synonymRelationship)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Update a Synonym relationship which is a link between glossary terms that have the same meaning
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonymRelationship - the Synonym relationship
    
    Returns:
    
    updated Synonym relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceSynonymRelationship
```
Synonym replaceSynonymRelationship(String userId,
                                   Synonym synonymRelationship)
                            throws InvalidParameterException,
                                   MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Replace a Synonym relationship which is a link between glossary terms that have the same meaning
    
    Parameters:
    
    userId - userId under which the request is performed
    
    synonymRelationship - the Synonym relationship
    
    Returns:
    
    replaced synonym relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteSynonymRelationship
```
Synonym deleteSynonymRelationship(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UnrecognizedGUIDException,
                                  UserNotAuthorizedException,
                                  FunctionNotSupportedException,
                                  RelationshipNotDeletedException,
                                  UnexpectedResponseException,
                                  PropertyServerException
```
    Delete a synonym relationship. A link between glossary terms that have the same meaning. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Synonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeSynonymRelationship
```
void purgeSynonymRelationship(String userId,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              UnrecognizedGUIDException,
                              MetadataServerUncontactableException,
                              UnexpectedResponseException,
                              RelationshipNotPurgedException,
                              PropertyServerException,
                              FunctionNotSupportedException
```
    Purge a synonym relationship. A link between glossary terms that have the same meaning. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreSynonymRelationship
```
Synonym restoreSynonymRelationship(String userId,
                                   String guid)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   MetadataServerUncontactableException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Restore a Synonym relationship Restore allows the deleted Synonym relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to delete
    
    Returns:
    
    response which when successful contains the restored Synonym relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createAntonymRelationship
```
Antonym createAntonymRelationship(String userId,
                                  Antonym antonym)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  MetadataServerUncontactableException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Create a antonym relationship. A link between glossary terms that have the opposite meaning.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonym - the Antonym relationship
    
    Returns:
    
    the created antonym relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getAntonymRelationship
```
Antonym getAntonymRelationship(String userId,
                               String guid)
                        throws InvalidParameterException,
                               MetadataServerUncontactableException,
                               UserNotAuthorizedException,
                               UnexpectedResponseException,
                               UnrecognizedGUIDException,
                               PropertyServerException,
                               FunctionNotSupportedException
```
    Get a antonym relationship. A link between glossary terms that have the opposite meaning.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Antonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateAntonymRelationship
```
Antonym updateAntonymRelationship(String userId,
                                  Antonym antonymRelationship)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  UnexpectedResponseException,
                                  UnrecognizedGUIDException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonymRelationship - the Antonym relationship
    
    Returns:
    
    Antonym updated antonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceAntonymRelationship
```
Antonym replaceAntonymRelationship(String userId,
                                   Antonym antonymRelationship)
                            throws InvalidParameterException,
                                   MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Replace an Antonym relationship which is a link between glossary terms that have the opposite meaning
    
    Parameters:
    
    userId - userId under which the request is performed
    
    antonymRelationship - the antonym relationship
    
    Returns:
    
    Antonym replaced antonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteAntonymRelationship
```
Antonym deleteAntonymRelationship(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  MetadataServerUncontactableException,
                                  UserNotAuthorizedException,
                                  UnrecognizedGUIDException,
                                  FunctionNotSupportedException,
                                  RelationshipNotDeletedException,
                                  UnexpectedResponseException,
                                  PropertyServerException
```
    Delete a antonym relationship. A link between glossary terms that have the opposite meaning. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Antonym Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeAntonymRelationship
```
void purgeAntonymRelationship(String userId,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              UnrecognizedGUIDException,
                              MetadataServerUncontactableException,
                              UnexpectedResponseException,
                              RelationshipNotPurgedException,
                              PropertyServerException,
                              FunctionNotSupportedException
```
    Purge a antonym relationship. A link between glossary terms that have the opposite meaning. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreAntonymRelationship
```
Antonym restoreAntonymRelationship(String userId,
                                   String guid)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   MetadataServerUncontactableException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Restore a Antonym relationship Restore allows the deleted Antonym relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete
    
    Returns:
    
    response which when successful contains the restored Antonym relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTranslationRelationship
```
Translation createTranslationRelationship(String userId,
                                          Translation translation)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException,
                                          PropertyServerException,
                                          FunctionNotSupportedException
```
    Create a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translation - the Translation relationship
    
    Returns:
    
    the created translation relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTranslationRelationship
```
Translation getTranslationRelationship(String userId,
                                       String guid)
                                throws InvalidParameterException,
                                       MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException,
                                       PropertyServerException,
                                       FunctionNotSupportedException
```
    Get a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Translation Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTranslationRelationship
```
Translation updateTranslationRelationship(String userId,
                                          Translation translationRelationship)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException,
                                          PropertyServerException,
                                          FunctionNotSupportedException
```
    Update a Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translationRelationship - the Translation relationship
    
    Returns:
    
    Translation updated translation Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    FunctionNotSupportedException - function not supported
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTranslationRelationship
```
Translation replaceTranslationRelationship(String userId,
                                           Translation translationRelationship)
                                    throws InvalidParameterException,
                                           MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           UnexpectedResponseException,
                                           UnrecognizedGUIDException,
                                           PropertyServerException,
                                           FunctionNotSupportedException
```
    Replace an Translation relationship, which is link between glossary terms that provide different natural language translation of the same concept.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    translationRelationship - the translation relationship
    
    Returns:
    
    Translation replaced translation Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTranslationRelationship
```
Translation deleteTranslationRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnrecognizedGUIDException,
                                          FunctionNotSupportedException,
                                          RelationshipNotDeletedException,
                                          UnexpectedResponseException,
                                          PropertyServerException
```
    Delete a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Translation Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTranslationRelationship
```
void purgeTranslationRelationship(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  UnrecognizedGUIDException,
                                  MetadataServerUncontactableException,
                                  UnexpectedResponseException,
                                  RelationshipNotPurgedException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Purge a translation relationship, which is link between glossary terms that provide different natural language translation of the same concept. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTranslationRelationship
```
Translation restoreTranslationRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           MetadataServerUncontactableException,
                                           UnexpectedResponseException,
                                           UnrecognizedGUIDException,
                                           PropertyServerException,
                                           FunctionNotSupportedException
```
    Restore a Translation relationship Restore allows the deleted Translation relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete
    
    Returns:
    
    response which when successful contains the restored Translation relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createUsedInContextRelationship
```
UsedInContext createUsedInContextRelationship(String userId,
                                              UsedInContext usedInContext)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              MetadataServerUncontactableException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException,
                                              PropertyServerException,
                                              FunctionNotSupportedException
```
    Create a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContext - the UsedInContext relationship
    
    Returns:
    
    the created usedInContext relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getUsedInContextRelationship
```
UsedInContext getUsedInContextRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           UnexpectedResponseException,
                                           UnrecognizedGUIDException,
                                           PropertyServerException,
                                           FunctionNotSupportedException
```
    Get a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    UsedInContext Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateUsedInContextRelationship
```
UsedInContext updateUsedInContextRelationship(String userId,
                                              UsedInContext usedInContextRelationship)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException,
                                              PropertyServerException,
                                              FunctionNotSupportedException
```
    Update a UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContextRelationship - the UsedInContext relationship
    
    Returns:
    
    UsedInContext updated usedInContext Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceUsedInContextRelationship
```
UsedInContext replaceUsedInContextRelationship(String userId,
                                               UsedInContext usedInContextRelationship)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException,
                                               PropertyServerException,
                                               FunctionNotSupportedException
```
    Replace an UsedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    usedInContextRelationship - the usedInContext relationship
    
    Returns:
    
    UsedInContext replaced usedInContext Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteUsedInContextRelationship
```
UsedInContext deleteUsedInContextRelationship(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnrecognizedGUIDException,
                                              FunctionNotSupportedException,
                                              RelationshipNotDeletedException,
                                              UnexpectedResponseException,
                                              PropertyServerException
```
    Delete a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted UsedInContext Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeUsedInContextRelationship
```
void purgeUsedInContextRelationship(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    RelationshipNotPurgedException,
                                    UnrecognizedGUIDException,
                                    MetadataServerUncontactableException,
                                    UnexpectedResponseException,
                                    PropertyServerException,
                                    FunctionNotSupportedException
```
    Purge a usedInContext relationship, which is link between glossary terms where on describes the context where the other one is valid to use. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the UsedInContext relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreUsedInContextRelationship
```
UsedInContext restoreUsedInContextRelationship(String userId,
                                               String guid)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException,
                                               PropertyServerException,
                                               FunctionNotSupportedException
```
    Restore a Used in context relationship Restore allows the deleted Used in context relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Used in context relationship to delete
    
    Returns:
    
    response which when successful contains the restored Used in context relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createPreferredTermRelationship
```
PreferredTerm createPreferredTermRelationship(String userId,
                                              PreferredTerm preferredTerm)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              MetadataServerUncontactableException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException,
                                              PropertyServerException,
                                              FunctionNotSupportedException
```
    Create a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTerm - the PreferredTerm relationship
    
    Returns:
    
    the created preferredTerm relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getPreferredTermRelationship
```
PreferredTerm getPreferredTermRelationship(String userId,
                                           String guid)
                                    throws InvalidParameterException,
                                           MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           UnexpectedResponseException,
                                           UnrecognizedGUIDException,
                                           PropertyServerException,
                                           FunctionNotSupportedException
```
    Get a preferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    PreferredTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updatePreferredTermRelationship
```
PreferredTerm updatePreferredTermRelationship(String userId,
                                              PreferredTerm preferredTermRelationship)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnexpectedResponseException,
                                              UnrecognizedGUIDException,
                                              PropertyServerException,
                                              FunctionNotSupportedException
```
    Update a PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTermRelationship - the PreferredTerm relationship
    
    Returns:
    
    PreferredTerm updated preferredTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replacePreferredTermRelationship
```
PreferredTerm replacePreferredTermRelationship(String userId,
                                               PreferredTerm preferredTermRelationship)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException,
                                               PropertyServerException,
                                               FunctionNotSupportedException
```
    Replace an PreferredTerm relationship, which is link to an alternative term that the organization prefer is used.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    preferredTermRelationship - the preferredTerm relationship
    
    Returns:
    
    PreferredTerm replaced preferredTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deletePreferredTermRelationship
```
PreferredTerm deletePreferredTermRelationship(String userId,
                                              String guid)
                                       throws InvalidParameterException,
                                              MetadataServerUncontactableException,
                                              UserNotAuthorizedException,
                                              UnrecognizedGUIDException,
                                              FunctionNotSupportedException,
                                              RelationshipNotDeletedException,
                                              UnexpectedResponseException,
                                              PropertyServerException
```
    Delete a preferredTerm relationship, which is link to an alternative term that the organization prefer is used. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted PreferredTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgePreferredTermRelationship
```
void purgePreferredTermRelationship(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    RelationshipNotPurgedException,
                                    UnrecognizedGUIDException,
                                    MetadataServerUncontactableException,
                                    UnexpectedResponseException,
                                    PropertyServerException,
                                    FunctionNotSupportedException
```
    Purge a preferredTerm relationship, which is link to an alternative term that the organization prefer is used. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the PreferredTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restorePreferredTermRelationship
```
PreferredTerm restorePreferredTermRelationship(String userId,
                                               String guid)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               MetadataServerUncontactableException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException,
                                               PropertyServerException,
                                               FunctionNotSupportedException
```
    Restore a preferred term relationship Restore allows the deleted preferred term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the preferred term relationship to delete
    
    Returns:
    
    response which when successful contains the restored preferred term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createValidValueRelationship
```
ValidValue createValidValueRelationship(String userId,
                                        ValidValue validValue)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException,
                                        UnrecognizedGUIDException,
                                        PropertyServerException,
                                        FunctionNotSupportedException
```
    Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValue - the ValidValue relationship
    
    Returns:
    
    the created validValue relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getValidValueRelationship
```
ValidValue getValidValueRelationship(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     UnexpectedResponseException,
                                     UnrecognizedGUIDException,
                                     PropertyServerException,
                                     FunctionNotSupportedException
```
    Get a validValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ValidValue Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateValidValueRelationship
```
ValidValue updateValidValueRelationship(String userId,
                                        ValidValue validValueRelationship)
                                 throws InvalidParameterException,
                                        MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        UnexpectedResponseException,
                                        UnrecognizedGUIDException,
                                        PropertyServerException,
                                        FunctionNotSupportedException
```
    Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValueRelationship - the ValidValue relationship
    
    Returns:
    
    ValidValue updated validValue Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceValidValueRelationship
```
ValidValue replaceValidValueRelationship(String userId,
                                         ValidValue validValueRelationship)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Replace an ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    validValueRelationship - the validValue relationship
    
    Returns:
    
    ValidValue replaced validValue Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteValidValueRelationship
```
ValidValue deleteValidValueRelationship(String userId,
                                        String guid)
                                 throws InvalidParameterException,
                                        MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        UnrecognizedGUIDException,
                                        FunctionNotSupportedException,
                                        RelationshipNotDeletedException,
                                        UnexpectedResponseException,
                                        PropertyServerException
```
    Delete a validValue relationship, which is link between glossary terms where one defines one of the data values for the another. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ValidValue Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeValidValueRelationship
```
void purgeValidValueRelationship(String userId,
                                 String guid)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 RelationshipNotPurgedException,
                                 UnrecognizedGUIDException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException,
                                 PropertyServerException,
                                 FunctionNotSupportedException
```
    Purge a validValue relationship, which is link between glossary terms where one defines one of the data values for the another. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ValidValue relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreValidValueRelationship
```
ValidValue restoreValidValueRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Restore a valid value relationship Restore allows the deleted valid value relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the valid value relationship to delete
    
    Returns:
    
    response which when successful contains the restored valid value relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createReplacementTermRelationship
```
ReplacementTerm createReplacementTermRelationship(String userId,
                                                  ReplacementTerm replacementTerm)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  MetadataServerUncontactableException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException,
                                                  PropertyServerException,
                                                  FunctionNotSupportedException
```
    Create a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTerm - the ReplacementTerm relationship
    
    Returns:
    
    the created replacementTerm relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getReplacementTermRelationship
```
ReplacementTerm getReplacementTermRelationship(String userId,
                                               String guid)
                                        throws InvalidParameterException,
                                               MetadataServerUncontactableException,
                                               UserNotAuthorizedException,
                                               UnexpectedResponseException,
                                               UnrecognizedGUIDException,
                                               PropertyServerException,
                                               FunctionNotSupportedException
```
    Get a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ReplacementTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateReplacementTermRelationship
```
ReplacementTerm updateReplacementTermRelationship(String userId,
                                                  ReplacementTerm replacementTermRelationship)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnexpectedResponseException,
                                                  UnrecognizedGUIDException,
                                                  PropertyServerException,
                                                  FunctionNotSupportedException
```
    Update a ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTermRelationship - the ReplacementTerm relationship
    
    Returns:
    
    ReplacementTerm updated replacementTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceReplacementTermRelationship
```
ReplacementTerm replaceReplacementTermRelationship(String userId,
                                                   ReplacementTerm replacementTermRelationship)
                                            throws InvalidParameterException,
                                                   MetadataServerUncontactableException,
                                                   UserNotAuthorizedException,
                                                   UnexpectedResponseException,
                                                   UnrecognizedGUIDException,
                                                   PropertyServerException,
                                                   FunctionNotSupportedException
```
    Replace an ReplacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    replacementTermRelationship - the replacementTerm relationship
    
    Returns:
    
    ReplacementTerm replaced replacementTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteReplacementTermRelationship
```
ReplacementTerm deleteReplacementTermRelationship(String userId,
                                                  String guid)
                                           throws InvalidParameterException,
                                                  MetadataServerUncontactableException,
                                                  UserNotAuthorizedException,
                                                  UnrecognizedGUIDException,
                                                  FunctionNotSupportedException,
                                                  RelationshipNotDeletedException,
                                                  UnexpectedResponseException,
                                                  PropertyServerException
```
    Delete a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ReplacementTerm Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeReplacementTermRelationship
```
void purgeReplacementTermRelationship(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      RelationshipNotPurgedException,
                                      UnrecognizedGUIDException,
                                      MetadataServerUncontactableException,
                                      UnexpectedResponseException,
                                      PropertyServerException,
                                      FunctionNotSupportedException
```
    Purge a replacementTerm relationship, which is link to a glossary term that is replacing an obsolete glossary term. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ReplacementTerm relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreReplacementTermRelationship
```
ReplacementTerm restoreReplacementTermRelationship(String userId,
                                                   String guid)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   MetadataServerUncontactableException,
                                                   UnexpectedResponseException,
                                                   UnrecognizedGUIDException,
                                                   PropertyServerException,
                                                   FunctionNotSupportedException
```
    Restore a replacement term relationship Restore allows the deleted replacement term relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the replacement term relationship to delete
    
    Returns:
    
    response which when successful contains the restored replacement term relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermTYPEDBYRelationship
```
TypedBy createTermTYPEDBYRelationship(String userId,
                                      TypedBy termTYPEDBYRelationship)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      MetadataServerUncontactableException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException,
                                      PropertyServerException,
                                      FunctionNotSupportedException
```
    Create a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the TypedBy relationship
    
    Returns:
    
    the created termTYPEDBYRelationship relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermTYPEDBYRelationship
```
TypedBy getTermTYPEDBYRelationship(String userId,
                                   String guid)
                            throws InvalidParameterException,
                                   MetadataServerUncontactableException,
                                   UserNotAuthorizedException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Get a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    TypedBy Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermTYPEDBYRelationship
```
TypedBy updateTermTYPEDBYRelationship(String userId,
                                      TypedBy termTYPEDBYRelationship)
                               throws InvalidParameterException,
                                      MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      UnexpectedResponseException,
                                      UnrecognizedGUIDException,
                                      PropertyServerException,
                                      FunctionNotSupportedException
```
    Update a TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the TypedBy relationship
    
    Returns:
    
    TypedBy updated termTYPEDBYRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermTYPEDBYRelationship
```
TypedBy replaceTermTYPEDBYRelationship(String userId,
                                       TypedBy termTYPEDBYRelationship)
                                throws InvalidParameterException,
                                       MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException,
                                       PropertyServerException,
                                       FunctionNotSupportedException
```
    Replace an TypedBy relationship, which is defines the relationship between a spine attribute and its type.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termTYPEDBYRelationship - the termTYPEDBYRelationship relationship
    
    Returns:
    
    TypedBy replaced termTYPEDBYRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermTYPEDBYRelationship
```
TypedBy deleteTermTYPEDBYRelationship(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      MetadataServerUncontactableException,
                                      UserNotAuthorizedException,
                                      UnrecognizedGUIDException,
                                      FunctionNotSupportedException,
                                      RelationshipNotDeletedException,
                                      UnexpectedResponseException,
                                      PropertyServerException
```
    Delete a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted TypedBy Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermTYPEDBYRelationship
```
void purgeTermTYPEDBYRelationship(String userId,
                                  String guid)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  RelationshipNotPurgedException,
                                  UnrecognizedGUIDException,
                                  MetadataServerUncontactableException,
                                  UnexpectedResponseException,
                                  PropertyServerException,
                                  FunctionNotSupportedException
```
    Purge a termTYPEDBYRelationship relationship, which is defines the relationship between a spine attribute and its type. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TypedBy relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTypedByRelationship
```
TypedBy restoreTypedByRelationship(String userId,
                                   String guid)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   MetadataServerUncontactableException,
                                   UnexpectedResponseException,
                                   UnrecognizedGUIDException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Restore a typed by relationship Restore allows the deleted typed by relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the typed by relationship to delete
    
    Returns:
    
    response which when successful contains the restored typed by relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createIsaRelationship
```
Isa createIsaRelationship(String userId,
                          Isa isa)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          MetadataServerUncontactableException,
                          UnexpectedResponseException,
                          UnrecognizedGUIDException,
                          PropertyServerException,
                          FunctionNotSupportedException
```
    Create a Isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isa - the Isa relationship
    
    Returns:
    
    the created isa relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getIsaRelationship
```
Isa getIsaRelationship(String userId,
                       String guid)
                throws InvalidParameterException,
                       MetadataServerUncontactableException,
                       UserNotAuthorizedException,
                       UnexpectedResponseException,
                       UnrecognizedGUIDException,
                       PropertyServerException,
                       FunctionNotSupportedException
```
    Get a isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    Isa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateIsaRelationship
```
Isa updateIsaRelationship(String userId,
                          Isa isaRelationship)
                   throws InvalidParameterException,
                          MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          UnexpectedResponseException,
                          UnrecognizedGUIDException,
                          PropertyServerException,
                          FunctionNotSupportedException
```
    Update a Isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isaRelationship - the Isa relationship
    
    Returns:
    
    Isa updated isa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceIsaRelationship
```
Isa replaceIsaRelationship(String userId,
                           Isa isaRelationship)
                    throws InvalidParameterException,
                           MetadataServerUncontactableException,
                           UserNotAuthorizedException,
                           UnexpectedResponseException,
                           UnrecognizedGUIDException,
                           PropertyServerException,
                           FunctionNotSupportedException
```
    Replace an Isa relationship, which is link between a more general glossary term and a more specific definition.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isaRelationship - the isa relationship
    
    Returns:
    
    Isa replaced isa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteIsaRelationship
```
Isa deleteIsaRelationship(String userId,
                          String guid)
                   throws InvalidParameterException,
                          MetadataServerUncontactableException,
                          UserNotAuthorizedException,
                          UnrecognizedGUIDException,
                          FunctionNotSupportedException,
                          RelationshipNotDeletedException,
                          UnexpectedResponseException,
                          PropertyServerException
```
    Delete a isa relationship, which is link between a more general glossary term and a more specific definition. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted Isa Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeIsaRelationship
```
void purgeIsaRelationship(String userId,
                          String guid)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          RelationshipNotPurgedException,
                          UnrecognizedGUIDException,
                          MetadataServerUncontactableException,
                          UnexpectedResponseException,
                          PropertyServerException,
                          FunctionNotSupportedException
```
    Purge a isa relationship, which is link between a more general glossary term and a more specific definition. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Isa relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreIsaRelationship
```
Isa restoreIsaRelationship(String userId,
                           String guid)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           MetadataServerUncontactableException,
                           UnexpectedResponseException,
                           UnrecognizedGUIDException,
                           PropertyServerException,
                           FunctionNotSupportedException
```
    Restore an is a relationship Restore allows the deleted is a relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the is a relationship to delete
    
    Returns:
    
    response which when successful contains the restored is a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermISATypeOFRelationship
```
IsaTypeOf createTermISATypeOFRelationship(String userId,
                                          IsaTypeOf TermISATypeOFRelationship)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          MetadataServerUncontactableException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException,
                                          PropertyServerException,
                                          FunctionNotSupportedException
```
    Create a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    TermISATypeOFRelationship - the IsaTypeOf relationship
    
    Returns:
    
    the created IsaTypeOf relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermISATypeOFRelationship
```
IsaTypeOf getTermISATypeOFRelationship(String userId,
                                       String guid)
                                throws InvalidParameterException,
                                       MetadataServerUncontactableException,
                                       UserNotAuthorizedException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException,
                                       PropertyServerException,
                                       FunctionNotSupportedException
```
    Get a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    IsaTypeOf Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermISATypeOFRelationship
```
IsaTypeOf updateTermISATypeOFRelationship(String userId,
                                          IsaTypeOf isATypeOf)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnexpectedResponseException,
                                          UnrecognizedGUIDException,
                                          PropertyServerException,
                                          FunctionNotSupportedException
```
    Update a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isATypeOf - the IsaTypeOf relationship
    
    Returns:
    
    IsaTypeOf updated IsaTypeOf Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermISATypeOFRelationship
```
IsaTypeOf replaceTermISATypeOFRelationship(String userId,
                                           IsaTypeOf isATypeOf)
                                    throws InvalidParameterException,
                                           MetadataServerUncontactableException,
                                           UserNotAuthorizedException,
                                           UnexpectedResponseException,
                                           UnrecognizedGUIDException,
                                           PropertyServerException,
                                           FunctionNotSupportedException
```
    Replace an isATypeOf relationship, which is defines an inheritance relationship between two spine objects.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    isATypeOf - the isATypeOf relationship
    
    Returns:
    
    isATypeOf replaced isATypeOf Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermISATypeOFRelationship
```
IsaTypeOf deleteTermISATypeOFRelationship(String userId,
                                          String guid)
                                   throws InvalidParameterException,
                                          MetadataServerUncontactableException,
                                          UserNotAuthorizedException,
                                          UnrecognizedGUIDException,
                                          FunctionNotSupportedException,
                                          RelationshipNotDeletedException,
                                          UnexpectedResponseException,
                                          PropertyServerException
```
    Delete a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted IsaTypeOf Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermISATypeOFRelationship
```
void purgeTermISATypeOFRelationship(String userId,
                                    String guid)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    RelationshipNotPurgedException,
                                    UnrecognizedGUIDException,
                                    MetadataServerUncontactableException,
                                    UnexpectedResponseException,
                                    PropertyServerException,
                                    FunctionNotSupportedException
```
    Purge a IsaTypeOf relationship, which is defines an inheritance relationship between two spine objects. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the IsaTypeOf relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreIsaTypeOfRelationship
```
IsaTypeOf restoreIsaTypeOfRelationship(String userId,
                                       String guid)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       MetadataServerUncontactableException,
                                       UnexpectedResponseException,
                                       UnrecognizedGUIDException,
                                       PropertyServerException,
                                       FunctionNotSupportedException
```
    Restore an is a type of relationship Restore allows the deleted is a type of relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the is a type of relationship to delete
    
    Returns:
    
    response which when successful contains the restored is a type of relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermCategorizationRelationship
```
Categorization createTermCategorizationRelationship(String userId,
                                                    Categorization termCategorizationRelationship)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    MetadataServerUncontactableException,
                                                    UnexpectedResponseException,
                                                    UnrecognizedGUIDException,
                                                    PropertyServerException,
                                                    FunctionNotSupportedException
```
    Create a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. Note that this method does not error if the relationship ends are not spine objects or spine attributes.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the created term categorization relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermCategorizationRelationship
```
Categorization getTermCategorizationRelationship(String userId,
                                                 String guid)
                                          throws InvalidParameterException,
                                                 MetadataServerUncontactableException,
                                                 UserNotAuthorizedException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException,
                                                 PropertyServerException,
                                                 FunctionNotSupportedException
```
    Get a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to get
    
    Returns:
    
    TermCategorizationRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateTermCategorizationRelationship
```
Categorization updateTermCategorizationRelationship(String userId,
                                                    Categorization termCategorizationRelationship)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    MetadataServerUncontactableException,
                                                    UnexpectedResponseException,
                                                    UnrecognizedGUIDException,
                                                    PropertyServerException,
                                                    FunctionNotSupportedException
```
    Update a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the updated term categorization relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermCategorizationRelationship
```
Categorization replaceTermCategorizationRelationship(String userId,
                                                     Categorization termCategorizationRelationship)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException,
                                                     PropertyServerException,
                                                     FunctionNotSupportedException
```
    Replace a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the term categorization relationship
    
    Returns:
    
    the replaced term categorization relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermCategorizationRelationship
```
Categorization deleteTermCategorizationRelationship(String userId,
                                                    String guid)
                                             throws InvalidParameterException,
                                                    MetadataServerUncontactableException,
                                                    UserNotAuthorizedException,
                                                    UnrecognizedGUIDException,
                                                    FunctionNotSupportedException,
                                                    RelationshipNotDeletedException,
                                                    UnexpectedResponseException,
                                                    PropertyServerException
```
    Delete a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. * A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete
    
    Returns:
    
    Deleted TermCategorizationRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermCategorizationRelationship
```
void purgeTermCategorizationRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         RelationshipNotPurgedException,
                                         UnrecognizedGUIDException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Purge a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermCategorizationRelationship
```
Categorization restoreTermCategorizationRelationship(String userId,
                                                     String guid)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     MetadataServerUncontactableException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException,
                                                     PropertyServerException,
                                                     FunctionNotSupportedException
```
    Restore a Term Categorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized. Restore allows the deleted Term Categorization relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Term Categorization relationship to delete
    
    Returns:
    
    response which when successful contains the restored has a relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createTermAnchorRelationship
```
TermAnchor createTermAnchorRelationship(String userId,
                                        TermAnchor termAnchorRelationship)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        MetadataServerUncontactableException,
                                        UnexpectedResponseException,
                                        UnrecognizedGUIDException,
                                        PropertyServerException,
                                        FunctionNotSupportedException
```
    Create a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. This method does not error if the relationship ends are not spine objects or spine attributes. Terms created using the Subject Area OMAS cannot be created without a glossary and there can only be one glossary associated with a Term. This method is to allow glossaries to be associated with Terms that have not been created via the Subject Area OMAS or to recreate the TermAnchor relationship if it has been purged.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchor relationship
    
    Returns:
    
    the created TermAnchor relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getTermAnchorRelationship
```
TermAnchor getTermAnchorRelationship(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     MetadataServerUncontactableException,
                                     UserNotAuthorizedException,
                                     UnexpectedResponseException,
                                     UnrecognizedGUIDException,
                                     PropertyServerException,
                                     FunctionNotSupportedException
```
    Get a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to get
    
    Returns:
    
    TermAnchorRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceTermAnchorRelationship
```
TermAnchor replaceTermAnchorRelationship(String userId,
                                         TermAnchor termAnchorRelationship)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Replace a Term HASA Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchor relationship
    
    Returns:
    
    the updated TermAnchor relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteTermAnchorRelationship
```
TermAnchor deleteTermAnchorRelationship(String userId,
                                        String guid)
                                 throws InvalidParameterException,
                                        MetadataServerUncontactableException,
                                        UserNotAuthorizedException,
                                        UnrecognizedGUIDException,
                                        FunctionNotSupportedException,
                                        RelationshipNotDeletedException,
                                        UnexpectedResponseException,
                                        PropertyServerException
```
    Delete a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. * A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted TermAnchorRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeTermAnchorRelationship
```
void purgeTermAnchorRelationship(String userId,
                                 String guid)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 RelationshipNotPurgedException,
                                 UnrecognizedGUIDException,
                                 MetadataServerUncontactableException,
                                 UnexpectedResponseException,
                                 PropertyServerException,
                                 FunctionNotSupportedException
```
    Purge a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreTermAnchorRelationship
```
TermAnchor restoreTermAnchorRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         MetadataServerUncontactableException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Restore a Term Anchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a glossary. Restore allows the deleted Term Categorization relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Term Anchor relationship to delete
    
    Returns:
    
    response which when successful contains the restored Term Anchor relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createCategoryAnchorRelationship
```
CategoryAnchor createCategoryAnchorRelationship(String userId,
                                                CategoryAnchor categoryAnchorRelationship)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException,
                                                PropertyServerException,
                                                FunctionNotSupportedException
```
    Create a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. Categories created using the Subject Area OMAS cannot be created without a glossary and there can only be one glossary associated with a Category. This method is to allow glossaries to be associated with Categories that have not been created via the Subject Area OMAS or to recreate the CategoryAnchor relationship if it has been purged.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the created term categorization relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getCategoryAnchorRelationship
```
CategoryAnchor getCategoryAnchorRelationship(String userId,
                                             String guid)
                                      throws InvalidParameterException,
                                             MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException,
                                             PropertyServerException,
                                             FunctionNotSupportedException
```
    Get a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to get
    
    Returns:
    
    CategoryAnchorRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateCategoryAnchorRelationship
```
CategoryAnchor updateCategoryAnchorRelationship(String userId,
                                                CategoryAnchor categoryAnchorRelationship)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                MetadataServerUncontactableException,
                                                UnexpectedResponseException,
                                                UnrecognizedGUIDException,
                                                PropertyServerException,
                                                FunctionNotSupportedException
```
    Update a Category Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the updated category anchor relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceCategoryAnchorRelationship
```
CategoryAnchor replaceCategoryAnchorRelationship(String userId,
                                                 CategoryAnchor categoryAnchorRelationship)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException,
                                                 PropertyServerException,
                                                 FunctionNotSupportedException
```
    Replace a Category Anchor Relationship.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the category anchor relationship
    
    Returns:
    
    the replaced category anchor relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteCategoryAnchorRelationship
```
CategoryAnchor deleteCategoryAnchorRelationship(String userId,
                                                String guid)
                                         throws InvalidParameterException,
                                                MetadataServerUncontactableException,
                                                UserNotAuthorizedException,
                                                UnrecognizedGUIDException,
                                                FunctionNotSupportedException,
                                                RelationshipNotDeletedException,
                                                UnexpectedResponseException,
                                                PropertyServerException
```
    Delete a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categories to be owned by a glossary. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete
    
    Returns:
    
    Deleted CategoryAnchorRelationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeCategoryAnchorRelationship
```
void purgeCategoryAnchorRelationship(String userId,
                                     String guid)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     RelationshipNotPurgedException,
                                     UnrecognizedGUIDException,
                                     MetadataServerUncontactableException,
                                     UnexpectedResponseException,
                                     PropertyServerException,
                                     FunctionNotSupportedException
```
    Purge a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreCategoryAnchorRelationship
```
CategoryAnchor restoreCategoryAnchorRelationship(String userId,
                                                 String guid)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 MetadataServerUncontactableException,
                                                 UnexpectedResponseException,
                                                 UnrecognizedGUIDException,
                                                 PropertyServerException,
                                                 FunctionNotSupportedException
```
    Restore a Category Anchor Relationship. A relationship between a Glossary and a Category. This relationship allows categoriess to be owned by a glossary. Restore allows the deleted Category Anchor relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Category Anchor relationship to delete
    
    Returns:
    
    response which when successful contains the restored category anchor relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - createProjectScopeRelationship
```
ProjectScope createProjectScopeRelationship(String userId,
                                            ProjectScope projectScope)
                                     throws InvalidParameterException,
                                            UserNotAuthorizedException,
                                            MetadataServerUncontactableException,
                                            UnexpectedResponseException,
                                            UnrecognizedGUIDException,
                                            PropertyServerException,
                                            FunctionNotSupportedException
```
    Create a ProjectScope relationship. A link between the project content and the project.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScope - the ProjectScope relationship
    
    Returns:
    
    the created ProjectScope relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getProjectScopeRelationship
```
ProjectScope getProjectScopeRelationship(String userId,
                                         String guid)
                                  throws InvalidParameterException,
                                         MetadataServerUncontactableException,
                                         UserNotAuthorizedException,
                                         UnexpectedResponseException,
                                         UnrecognizedGUIDException,
                                         PropertyServerException,
                                         FunctionNotSupportedException
```
    Get a ProjectScope relationship. A link between the project content and the project.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to get
    
    Returns:
    
    ProjectScope Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - updateProjectScopeRelationship
```
ProjectScope updateProjectScopeRelationship(String userId,
                                            ProjectScope projectScopeRelationship)
                                     throws InvalidParameterException,
                                            MetadataServerUncontactableException,
                                            UserNotAuthorizedException,
                                            UnexpectedResponseException,
                                            UnrecognizedGUIDException,
                                            PropertyServerException,
                                            FunctionNotSupportedException
```
    Update a ProjectScope relationship which is a link between the project content and the project.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    updated ProjectScope relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - replaceProjectScopeRelationship
```
ProjectScope replaceProjectScopeRelationship(String userId,
                                             ProjectScope projectScopeRelationship)
                                      throws InvalidParameterException,
                                             MetadataServerUncontactableException,
                                             UserNotAuthorizedException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException,
                                             PropertyServerException,
                                             FunctionNotSupportedException
```
    Replace a ProjectScope relationship which is a link between the project content and the project.
    
    Parameters:
    
    userId - userId under which the request is performed
    
    projectScopeRelationship - the ProjectScope relationship
    
    Returns:
    
    replaced ProjectScope relationship Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - deleteProjectScopeRelationship
```
ProjectScope deleteProjectScopeRelationship(String userId,
                                            String guid)
                                     throws InvalidParameterException,
                                            MetadataServerUncontactableException,
                                            UnrecognizedGUIDException,
                                            UserNotAuthorizedException,
                                            FunctionNotSupportedException,
                                            RelationshipNotDeletedException,
                                            UnexpectedResponseException,
                                            PropertyServerException
```
    Delete a ProjectScope relationship. A link between the project content and the project. A delete (also known as a soft delete) means that the relationship instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    Returns:
    
    deleted ProjectScope Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException - Function not supported this indicates that a soft delete was issued but the repository does not support it.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotDeletedException - a soft delete was issued but the relationship was not deleted.
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - purgeProjectScopeRelationship
```
void purgeProjectScopeRelationship(String userId,
                                   String guid)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   RelationshipNotPurgedException,
                                   UnrecognizedGUIDException,
                                   MetadataServerUncontactableException,
                                   UnexpectedResponseException,
                                   PropertyServerException,
                                   FunctionNotSupportedException
```
    Purge a ProjectScope relationship. A link between the project content and the project. A purge means that the relationship will not exist after the operation.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to delete when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid.
    
    MetadataServerUncontactableException - not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
    
    RelationshipNotPurgedException - a hard delete was issued but the relationship was not purged
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - restoreProjectScopeRelationship
```
ProjectScope restoreProjectScopeRelationship(String userId,
                                             String guid)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             MetadataServerUncontactableException,
                                             UnexpectedResponseException,
                                             UnrecognizedGUIDException,
                                             PropertyServerException,
                                             FunctionNotSupportedException
```
    Restore a ProjectScope relationship which is a link between the project content and the project. Restore allows the deleted ProjectScope relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to restore
    
    Returns:
    
    response which when successful contains the restored ProjectScope relationship when not successful the following Exception responses can occur Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server
  - getSemanticAssignmentRelationship
```
SemanticAssignment getSemanticAssignmentRelationship(String userId,
                                                     String guid)
                                              throws InvalidParameterException,
                                                     MetadataServerUncontactableException,
                                                     UserNotAuthorizedException,
                                                     UnexpectedResponseException,
                                                     UnrecognizedGUIDException,
                                                     PropertyServerException,
                                                     FunctionNotSupportedException
```
    Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
    
    Parameters:
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the SemanticAssignment relationship to get
    
    Returns:
    
    the SemanticAssignment relationship with the requested guid Exceptions returned by the server
    
    Throws:
    
    UserNotAuthorizedException - the requesting user is not authorized to issue this request.
    
    InvalidParameterException - one of the parameters is null or invalid
    
    UnrecognizedGUIDException - the supplied guid was not recognised
    
    PropertyServerException - property server exception
    
    FunctionNotSupportedException - function not supported Client library Exceptions
    
    MetadataServerUncontactableException - Unable to contact the server
    
    UnexpectedResponseException - an unexpected response was returned from the server

Interface SubjectAreaRelationship

Method Summary

Method Detail

createTermHASARelationship

getTermHASARelationship

updateTermHASARelationship

replaceTermHASARelationship

deleteTermHASARelationship

purgeTermHASARelationship

restoreTermHASARelationship

createRelatedTerm

getRelatedTerm

updateRelatedTerm

replaceRelatedTerm

restoreRelatedTerm

deleteRelatedTerm

purgeRelatedTerm

createSynonymRelationship

getSynonymRelationship

updateSynonymRelationship

replaceSynonymRelationship

deleteSynonymRelationship

purgeSynonymRelationship

restoreSynonymRelationship

createAntonymRelationship

getAntonymRelationship

updateAntonymRelationship

replaceAntonymRelationship

deleteAntonymRelationship

purgeAntonymRelationship

restoreAntonymRelationship

createTranslationRelationship

getTranslationRelationship

updateTranslationRelationship

replaceTranslationRelationship

deleteTranslationRelationship

purgeTranslationRelationship

restoreTranslationRelationship

createUsedInContextRelationship

getUsedInContextRelationship

updateUsedInContextRelationship

replaceUsedInContextRelationship

deleteUsedInContextRelationship

purgeUsedInContextRelationship

restoreUsedInContextRelationship

createPreferredTermRelationship

getPreferredTermRelationship

updatePreferredTermRelationship

replacePreferredTermRelationship

deletePreferredTermRelationship

purgePreferredTermRelationship

restorePreferredTermRelationship

createValidValueRelationship

getValidValueRelationship

updateValidValueRelationship

replaceValidValueRelationship

deleteValidValueRelationship

purgeValidValueRelationship

restoreValidValueRelationship

createReplacementTermRelationship

getReplacementTermRelationship

updateReplacementTermRelationship

replaceReplacementTermRelationship

deleteReplacementTermRelationship

purgeReplacementTermRelationship

restoreReplacementTermRelationship

createTermTYPEDBYRelationship

getTermTYPEDBYRelationship

updateTermTYPEDBYRelationship

replaceTermTYPEDBYRelationship

deleteTermTYPEDBYRelationship

purgeTermTYPEDBYRelationship

restoreTypedByRelationship

createIsaRelationship

getIsaRelationship

updateIsaRelationship

replaceIsaRelationship

deleteIsaRelationship

purgeIsaRelationship

restoreIsaRelationship