SubjectAreaRelationshipRESTServices (Subject Area OMAS Server-side 2.9 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance
- - org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRelationshipRESTServices

```
public class SubjectAreaRelationshipRESTServices
extends SubjectAreaRESTServicesInstance
```
TheSubjectAreaTermRESTServices provides the server-side implementation of the SubjectArea Open Metadata Access Service (OMAS) for Terms. This interface provides relationship authoring interfaces for subject area experts.

Field Summary
- Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance
  instanceHandler

Constructor Summary

Constructors
Constructor and Description

SubjectAreaRelationshipRESTServices()
Default constructor

Constructors
Constructor and Description
`SubjectAreaRelationshipRESTServices()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubjectAreaOMASAPIResponse<Antonym>`	`createAntonym(String serverName, String userId, Antonym antonym)` Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`createCategoryAnchorRelationship(String serverName, String userId, CategoryAnchor categoryAnchorRelationship)` Create a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`createCategoryHierarchyLink(String serverName, String userId, CategoryHierarchyLink categoryHierarchyLink)` Create a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`createIsARelationship(String serverName, String userId, IsA iSARelationship)` Create a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`createPreferredTerm(String serverName, String userId, PreferredTerm preferredTermRelationship)` Create a preferredTermRelationship relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`createProjectScopeRelationship(String serverName, String userId, ProjectScope projectScope)` Create a projectScope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`createRelatedTerm(String serverName, String userId, RelatedTerm relatedTermRelationship)` Create a RelatedTerm.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`createReplacementTerm(String serverName, String userId, ReplacementTerm replacementTermRelationship)` Create a replacementTermRelationship relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<Synonym>`	`createSynonym(String serverName, String userId, Synonym synonym)` Create a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<TermAnchor>`	`createTermAnchorRelationship(String serverName, String userId, TermAnchor termAnchorRelationship)` Create a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`createTermCategorizationRelationship(String serverName, String userId, Categorization termCategorizationRelationship)` Create a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`createTermHasARelationship(String serverName, String userId, HasA termHasARelationship)` Create a Hasa is the relationship between a spine object and a spine attribute.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`createTermIsATypeOfRelationship(String serverName, String userId, IsATypeOf termIsATypeOfRelationship)` Create a termIsATypeOfRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<TypedBy>`	`createTermTypedByRelationship(String serverName, String userId, TypedBy termTypedByRelationship)` Create a termTypedByRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<Translation>`	`createTranslation(String serverName, String userId, Translation translationRelationship)` Create a translationRelationship relationship, which is a link between glossary terms to provide different natural language translationRelationship of the same concept.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`createUsedInContext(String serverName, String userId, UsedInContext usedInContextRelationship)` Create a usedInContextRelationship relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`createValidValue(String serverName, String userId, ValidValue validValueRelationship)` Create a validValueRelationship relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<Antonym>`	`deleteAntonymRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Antonym relationship
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`deleteCategoryAnchorRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a CategoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`deleteCategoryHierarchyLink(String serverName, String userId, String guid, Boolean isPurge)` Delete a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`deleteIsARelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Isa relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`deleteIsATypeOfRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a IsaTypeOf relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`deletePreferredTermRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`deleteProjectScopeRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a ProjectScope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`deleteRelatedTerm(String serverName, String userId, String guid, boolean isPurge)` Delete a Related Term relationship
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`deleteReplacementTerm(String serverName, String userId, String guid, Boolean isPurge)` Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<Synonym>`	`deleteSynonymRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Synonym relationship
`SubjectAreaOMASAPIResponse<TermAnchor>`	`deleteTermAnchorRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TermAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`deleteTermCategorizationRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TermCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`deleteTermHasARelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Term HAS A relationship
`SubjectAreaOMASAPIResponse<TypedBy>`	`deleteTermTypedByRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TypedBy relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<Translation>`	`deleteTranslationRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`deleteUsedInContextRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`deleteValidValueRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a ValidValue relationship
`SubjectAreaOMASAPIResponse<Antonym>`	`getAntonymRelationship(String serverName, String userId, String guid)` Get a antonym relationship
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`getCategoryAnchorRelationship(String serverName, String userId, String guid)` Get a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`getCategoryHierarchyLink(String serverName, String userId, String guid)` Get a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`getIsARelationship(String serverName, String userId, String guid)` Get a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`getPreferredTermRelationship(String serverName, String userId, String guid)` Get a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`getProjectScopeRelationship(String serverName, String userId, String guid)` Get a projectScope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`getRelatedTerm(String serverName, String userId, String guid)` Get a related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`getReplacementTerm(String serverName, String userId, String guid)` Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<SemanticAssignment>`	`getSemanticAssignmentRelationship(String serverName, 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.
`SubjectAreaOMASAPIResponse<Synonym>`	`getSynonymRelationship(String serverName, String userId, String guid)` Get a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<TermAnchor>`	`getTermAnchorRelationship(String serverName, String userId, String guid)` Get a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`getTermCategorizationRelationship(String serverName, String userId, String guid)` Get a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`getTermHasARelationship(String serverName, String userId, String guid)` Get a Term HAS A relationship
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`getTermIsATypeOfRelationship(String serverName, String userId, String guid)` Get a termIsATypeOfRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<TypedBy>`	`getTermTypedByRelationship(String serverName, String userId, String guid)` Get a termTypedByRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<Translation>`	`getTranslationRelationship(String serverName, String userId, String guid)` Get a translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`getUsedInContextRelationship(String serverName, String userId, String guid)` Get a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`getValidValueRelationship(String serverName, String userId, String guid)` Get a validValue relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<Antonym>`	`restoreAntonym(String serverName, String userId, String guid)` Restore an antonym relationship.
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`restoreCategoryAnchorRelationship(String serverName, String userId, String guid)` Restore a CategoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`restoreCategoryHierarchyLink(String serverName, String userId, String guid)` Restore a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`restoreIsARelationship(String serverName, String userId, String guid)` Restore a is a relationship.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`restorePreferredTerm(String serverName, String userId, String guid)` Restore a preferred term relationship.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`restoreProjectScopeRelationship(String serverName, String userId, String guid)` Restore a projectScope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`restoreRelatedTerm(String serverName, String userId, String guid)` Restore a related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`restoreReplacementTerm(String serverName, String userId, String guid)` Restore a replacement term relationship.
`SubjectAreaOMASAPIResponse<Synonym>`	`restoreSynonym(String serverName, String userId, String guid)` Restore a synonym relationship.
`SubjectAreaOMASAPIResponse<TermAnchor>`	`restoreTermAnchorRelationship(String serverName, String userId, String guid)` Restore a TermAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`restoreTermCategorizationRelationship(String serverName, String userId, String guid)` Restore a TermCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`restoreTermHasARelationship(String serverName, String userId, String guid)` Restore a Term HAS A relationship.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`restoreTermIsATypeOfRelationship(String serverName, String userId, String guid)` Restore a is IsaTypeOf relationship.
`SubjectAreaOMASAPIResponse<TypedBy>`	`restoreTermTypedByRelationship(String serverName, String userId, String guid)` Restore a replacement term relationship.
`SubjectAreaOMASAPIResponse<Translation>`	`restoreTranslation(String serverName, String userId, String guid)` Restore a translation relationship.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`restoreUsedInContext(String serverName, String userId, String guid)` Restore a used in context relationship.
`SubjectAreaOMASAPIResponse<ValidValue>`	`restoreValidValue(String serverName, String userId, String guid)` Restore a valid value relationship.
`SubjectAreaOMASAPIResponse<Antonym>`	`updateAntonymRelationship(String serverName, String userId, String guid, Antonym antonym, boolean isReplace)` Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`updateCategoryAnchorRelationship(String serverName, String userId, String guid, CategoryAnchor categoryAnchor, Boolean isReplace)` Update a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`updateCategoryHierarchyLink(String serverName, String userId, String guid, CategoryHierarchyLink categoryHierarchyLink, Boolean isReplace)` Update a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`updateIsARelationship(String serverName, String userId, String guid, IsA iSARelationship, boolean isReplace)` Update a Isa relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`updatePreferredTermRelationship(String serverName, String userId, String guid, PreferredTerm preferredTermRelationship, boolean isReplace)` Update a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`updateProjectScopeRelationship(String serverName, String userId, String guid, ProjectScope projectScope, boolean isReplace)` Update a ProjectScope relationship which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`updateRelatedTerm(String serverName, String userId, String guid, RelatedTerm relatedTermRelationship, boolean isReplace)` Update a Related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`updateReplacementTerm(String serverName, String userId, String guid, ReplacementTerm replacementTermRelationship, boolean isReplace)` Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<Synonym>`	`updateSynonymRelationship(String serverName, String userId, String guid, Synonym synonym, boolean isReplace)` Update a Synonym relationship which is a link between glossary terms that have the same meaning
`SubjectAreaOMASAPIResponse<TermAnchor>`	`updateTermAnchorRelationship(String serverName, String userId, String guid, TermAnchor termAnchor, Boolean isReplace)` Update a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`updateTermCategorizationRelationship(String serverName, String userId, String guid, Categorization termCategorizationRelationship, Boolean isReplace)` Update a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`updateTermHasARelationship(String serverName, String userId, String guid, HasA termHasARelationship, boolean isReplace)` Update a Hasa is the relationship between a spine object and a spine attribute.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`updateTermIsATypeOfRelationship(String serverName, String userId, String guid, IsATypeOf termIsATypeOfRelationship, boolean isReplace)` Update a IsaTypeOf relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<TypedBy>`	`updateTermTypedByRelationship(String serverName, String userId, String guid, TypedBy termTypedByRelationship, boolean isReplace)` Update a TypedBy relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<Translation>`	`updateTranslationRelationship(String serverName, String userId, String guid, Translation translationRelationship, boolean isReplace)` Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`updateUsedInContextRelationship(String serverName, String userId, String guid, UsedInContext usedInContextRelationship, boolean isReplace)` Update a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`updateValidValueRelationship(String serverName, String userId, String guid, ValidValue validValueRelationship, boolean isReplace)` Update a ValidValue relationship which is a link between glossary terms that have the same meaning

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance
createRelationship, deleteRelationship, getFindRequest, getRelationship, getResponseForException, restoreRelationship, updateRelationship

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

- Constructor Detail
  - SubjectAreaRelationshipRESTServices
```
public SubjectAreaRelationshipRESTServices()
```
    Default constructor
- Method Detail
  - createTermHasARelationship
```
public SubjectAreaOMASAPIResponse<HasA> createTermHasARelationship(String serverName,
                                                                   String userId,
                                                                   HasA termHasARelationship)
```
    Create a Hasa is the 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. This allows the user to create terms then make them spine objects and spine attributes at a later stage.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    termHasARelationship - the HASA relationship
    
    Returns:
    response, when successful contains the created Hasa when not successful the following Exception responses can occur
    
    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.
    
    FunctionNotSupportedException Function not supported.
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
  - getTermHasARelationship
```
public SubjectAreaOMASAPIResponse<HasA> getTermHasARelationship(String serverName,
                                                                String userId,
                                                                String guid)
```
    Get a Term HAS A relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the HAS A relationship to get
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTermHasARelationship
```
public SubjectAreaOMASAPIResponse<HasA> updateTermHasARelationship(String serverName,
                                                                   String userId,
                                                                   String guid,
                                                                   HasA termHasARelationship,
                                                                   boolean isReplace)
```
    Update a Hasa is the relationship between a spine object and a spine attribute.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    termHasARelationship - the HASA relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated Hasa when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteTermHasARelationship
```
public SubjectAreaOMASAPIResponse<HasA> deleteTermHasARelationship(String serverName,
                                                                   String userId,
                                                                   String guid,
                                                                   Boolean isPurge)
```
    Delete a Term HAS A relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the HAS A relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete, the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermHasARelationship
```
public SubjectAreaOMASAPIResponse<HasA> restoreTermHasARelationship(String serverName,
                                                                    String userId,
                                                                    String guid)
```
    Restore a Term HAS A relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createRelatedTerm
```
public SubjectAreaOMASAPIResponse<RelatedTerm> createRelatedTerm(String serverName,
                                                                 String userId,
                                                                 RelatedTerm relatedTermRelationship)
```
    Create a RelatedTerm. A Related Term is a link between two similar Terms.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    relatedTermRelationship - the RelatedTerm relationship
    
    Returns:
    response, when successful contains the restored Related Term relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getRelatedTerm
```
public SubjectAreaOMASAPIResponse<RelatedTerm> getRelatedTerm(String serverName,
                                                              String userId,
                                                              String guid)
```
    Get a related Term relationship.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the related term relationship to get
    
    Returns:
    response which when successful contains the related term relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateRelatedTerm
```
public SubjectAreaOMASAPIResponse<RelatedTerm> updateRelatedTerm(String serverName,
                                                                 String userId,
                                                                 String guid,
                                                                 RelatedTerm relatedTermRelationship,
                                                                 boolean isReplace)
```
    Update a Related Term relationship. A Related Term is a link between two similar Terms.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    relatedTermRelationship - the related term relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated RelatedTerm when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteRelatedTerm
```
public SubjectAreaOMASAPIResponse<RelatedTerm> deleteRelatedTerm(String serverName,
                                                                 String userId,
                                                                 String guid,
                                                                 boolean isPurge)
```
    Delete a Related Term relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Related term relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreRelatedTerm
```
public SubjectAreaOMASAPIResponse<RelatedTerm> restoreRelatedTerm(String serverName,
                                                                  String userId,
                                                                  String guid)
```
    Restore a related Term relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createSynonym
```
public SubjectAreaOMASAPIResponse<Synonym> createSynonym(String serverName,
                                                         String userId,
                                                         Synonym synonym)
```
    Create a synonym relationship, which is a link between glossary terms that have the same meaning.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    synonym - the Synonym relationship
    
    Returns:
    response, when successful contains the created synonym relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - getSynonymRelationship
```
public SubjectAreaOMASAPIResponse<Synonym> getSynonymRelationship(String serverName,
                                                                  String userId,
                                                                  String guid)
```
    Get a synonym relationship, which is a link between glossary terms that have the same meaning.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termCategorization relationship to get
    
    Returns:
    response which when successful contains the termCategorization relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateSynonymRelationship
```
public SubjectAreaOMASAPIResponse<Synonym> updateSynonymRelationship(String serverName,
                                                                     String userId,
                                                                     String guid,
                                                                     Synonym synonym,
                                                                     boolean isReplace)
```
    Update a Synonym relationship which is a link between glossary terms that have the same meaning
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    synonym - the Synonym relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated SynonymRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    FunctionNotSupportedException Function is not supported.
    
    StatusNotSupportedException A status value is not supported.
  - deleteSynonymRelationship
```
public SubjectAreaOMASAPIResponse<Synonym> deleteSynonymRelationship(String serverName,
                                                                     String userId,
                                                                     String guid,
                                                                     Boolean isPurge)
```
    Delete a Synonym relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Synonym relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreSynonym
```
public SubjectAreaOMASAPIResponse<Synonym> restoreSynonym(String serverName,
                                                          String userId,
                                                          String guid)
```
    Restore a synonym relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createAntonym
```
public SubjectAreaOMASAPIResponse<Antonym> createAntonym(String serverName,
                                                         String userId,
                                                         Antonym antonym)
```
    Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    antonym - the Antonym relationship
    
    Returns:
    response, when successful contains the created antonym relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - getAntonymRelationship
```
public SubjectAreaOMASAPIResponse<Antonym> getAntonymRelationship(String serverName,
                                                                  String userId,
                                                                  String guid)
```
    Get a antonym relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the related term relationship to get
    
    Returns:
    response which when successful contains the antonym relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateAntonymRelationship
```
public SubjectAreaOMASAPIResponse<Antonym> updateAntonymRelationship(String serverName,
                                                                     String userId,
                                                                     String guid,
                                                                     Antonym antonym,
                                                                     boolean isReplace)
```
    Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    antonym - the Antonym relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated AntonymRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - deleteAntonymRelationship
```
public SubjectAreaOMASAPIResponse<Antonym> deleteAntonymRelationship(String serverName,
                                                                     String userId,
                                                                     String guid,
                                                                     Boolean isPurge)
```
    Delete a Antonym relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Antonym relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreAntonym
```
public SubjectAreaOMASAPIResponse<Antonym> restoreAntonym(String serverName,
                                                          String userId,
                                                          String guid)
```
    Restore an antonym relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    FunctionNotSupportedException Function is not supported.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createTranslation
```
public SubjectAreaOMASAPIResponse<Translation> createTranslation(String serverName,
                                                                 String userId,
                                                                 Translation translationRelationship)
```
    Create a translationRelationship relationship, which is a link between glossary terms to provide different natural language translationRelationship of the same concept.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    translationRelationship - the Translation relationship
    
    Returns:
    response, when successful contains the created translationRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - getTranslationRelationship
```
public SubjectAreaOMASAPIResponse<Translation> getTranslationRelationship(String serverName,
                                                                          String userId,
                                                                          String guid)
```
    Get a translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the translation relationship to get
    
    Returns:
    response which when successful contains the translation relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTranslationRelationship
```
public SubjectAreaOMASAPIResponse<Translation> updateTranslationRelationship(String serverName,
                                                                             String userId,
                                                                             String guid,
                                                                             Translation translationRelationship,
                                                                             boolean isReplace)
```
    Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    translationRelationship - the Translation relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated TranslationRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - deleteTranslationRelationship
```
public SubjectAreaOMASAPIResponse<Translation> deleteTranslationRelationship(String serverName,
                                                                             String userId,
                                                                             String guid,
                                                                             Boolean isPurge)
```
    Delete a Translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Translation relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTranslation
```
public SubjectAreaOMASAPIResponse<Translation> restoreTranslation(String serverName,
                                                                  String userId,
                                                                  String guid)
```
    Restore a translation relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createUsedInContext
```
public SubjectAreaOMASAPIResponse<UsedInContext> createUsedInContext(String serverName,
                                                                     String userId,
                                                                     UsedInContext usedInContextRelationship)
```
    Create a usedInContextRelationship relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    usedInContextRelationship - the UsedInContext relationship
    
    Returns:
    response, when successful contains the created usedInContextRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - getUsedInContextRelationship
```
public SubjectAreaOMASAPIResponse<UsedInContext> getUsedInContextRelationship(String serverName,
                                                                              String userId,
                                                                              String guid)
```
    Get a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the usedInContext relationship to get
    
    Returns:
    response which when successful contains the usedInContext relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateUsedInContextRelationship
```
public SubjectAreaOMASAPIResponse<UsedInContext> updateUsedInContextRelationship(String serverName,
                                                                                 String userId,
                                                                                 String guid,
                                                                                 UsedInContext usedInContextRelationship,
                                                                                 boolean isReplace)
```
    Update a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    usedInContextRelationship - the UsedInContext relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated UsedInContextRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
  - deleteUsedInContextRelationship
```
public SubjectAreaOMASAPIResponse<UsedInContext> deleteUsedInContextRelationship(String serverName,
                                                                                 String userId,
                                                                                 String guid,
                                                                                 Boolean isPurge)
```
    Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the UsedInContext relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreUsedInContext
```
public SubjectAreaOMASAPIResponse<UsedInContext> restoreUsedInContext(String serverName,
                                                                      String userId,
                                                                      String guid)
```
    Restore a used in context relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createPreferredTerm
```
public SubjectAreaOMASAPIResponse<PreferredTerm> createPreferredTerm(String serverName,
                                                                     String userId,
                                                                     PreferredTerm preferredTermRelationship)
```
    Create a preferredTermRelationship relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    preferredTermRelationship - the preferred Term relationship
    
    Returns:
    response, when successful contains the created preferredTermRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getPreferredTermRelationship
```
public SubjectAreaOMASAPIResponse<PreferredTerm> getPreferredTermRelationship(String serverName,
                                                                              String userId,
                                                                              String guid)
```
    Get a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the preferredTerm relationship to get
    
    Returns:
    response which when successful contains the preferredTerm relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updatePreferredTermRelationship
```
public SubjectAreaOMASAPIResponse<PreferredTerm> updatePreferredTermRelationship(String serverName,
                                                                                 String userId,
                                                                                 String guid,
                                                                                 PreferredTerm preferredTermRelationship,
                                                                                 boolean isReplace)
```
    Update a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    preferredTermRelationship - the PreferredTerm relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated PreferredTermRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    FunctionNotSupportedException Function not supported
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deletePreferredTermRelationship
```
public SubjectAreaOMASAPIResponse<PreferredTerm> deletePreferredTermRelationship(String serverName,
                                                                                 String userId,
                                                                                 String guid,
                                                                                 Boolean isPurge)
```
    Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the PreferredTerm relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restorePreferredTerm
```
public SubjectAreaOMASAPIResponse<PreferredTerm> restorePreferredTerm(String serverName,
                                                                      String userId,
                                                                      String guid)
```
    Restore a preferred term relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createValidValue
```
public SubjectAreaOMASAPIResponse<ValidValue> createValidValue(String serverName,
                                                               String userId,
                                                               ValidValue validValueRelationship)
```
    Create a validValueRelationship relationship, which is a link between glossary terms that have the same meaning.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    validValueRelationship - the ValidValue relationship
    
    Returns:
    response, when successful contains the created validValueRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getValidValueRelationship
```
public SubjectAreaOMASAPIResponse<ValidValue> getValidValueRelationship(String serverName,
                                                                        String userId,
                                                                        String guid)
```
    Get a validValue relationship, which is a link between glossary terms that have the same meaning.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the validValue relationship to get
    
    Returns:
    response which when successful contains the validValue relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateValidValueRelationship
```
public SubjectAreaOMASAPIResponse<ValidValue> updateValidValueRelationship(String serverName,
                                                                           String userId,
                                                                           String guid,
                                                                           ValidValue validValueRelationship,
                                                                           boolean isReplace)
```
    Update a ValidValue relationship which is a link between glossary terms that have the same meaning
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    validValueRelationship - the ValidValue relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated ValidValueRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteValidValueRelationship
```
public SubjectAreaOMASAPIResponse<ValidValue> deleteValidValueRelationship(String serverName,
                                                                           String userId,
                                                                           String guid,
                                                                           Boolean isPurge)
```
    Delete a ValidValue relationship
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ValidValue relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreValidValue
```
public SubjectAreaOMASAPIResponse<ValidValue> restoreValidValue(String serverName,
                                                                String userId,
                                                                String guid)
```
    Restore a valid value relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createReplacementTerm
```
public SubjectAreaOMASAPIResponse<ReplacementTerm> createReplacementTerm(String serverName,
                                                                         String userId,
                                                                         ReplacementTerm replacementTermRelationship)
```
    Create a replacementTermRelationship relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    replacementTermRelationship - the ReplacementTerm relationship
    
    Returns:
    response, when successful contains the created replacementTermRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getReplacementTerm
```
public SubjectAreaOMASAPIResponse<ReplacementTerm> getReplacementTerm(String serverName,
                                                                      String userId,
                                                                      String guid)
```
    Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the replacementTerm relationship to get
    
    Returns:
    response which when successful contains the replacementTerm relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateReplacementTerm
```
public SubjectAreaOMASAPIResponse<ReplacementTerm> updateReplacementTerm(String serverName,
                                                                         String userId,
                                                                         String guid,
                                                                         ReplacementTerm replacementTermRelationship,
                                                                         boolean isReplace)
```
    Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    replacementTermRelationship - the ReplacementTerm relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated ReplacementRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteReplacementTerm
```
public SubjectAreaOMASAPIResponse<ReplacementTerm> deleteReplacementTerm(String serverName,
                                                                         String userId,
                                                                         String guid,
                                                                         Boolean isPurge)
```
    Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ReplacementTerm relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreReplacementTerm
```
public SubjectAreaOMASAPIResponse<ReplacementTerm> restoreReplacementTerm(String serverName,
                                                                          String userId,
                                                                          String guid)
```
    Restore a replacement term relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
    
    FunctionNotSupportedException Function not supported.
  - createTermTypedByRelationship
```
public SubjectAreaOMASAPIResponse<TypedBy> createTermTypedByRelationship(String serverName,
                                                                         String userId,
                                                                         TypedBy termTypedByRelationship)
```
    Create a termTypedByRelationship relationship, which is a link between a spine attribute and its type.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    termTypedByRelationship - the TypedBy relationship
    
    Returns:
    response, when successful contains the created termTypedByRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
  - getTermTypedByRelationship
```
public SubjectAreaOMASAPIResponse<TypedBy> getTermTypedByRelationship(String serverName,
                                                                      String userId,
                                                                      String guid)
```
    Get a termTypedByRelationship relationship, which is a link between a spine attribute and its type.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termTypedByRelationship relationship to get
    
    Returns:
    response which when successful contains the termTypedByRelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTermTypedByRelationship
```
public SubjectAreaOMASAPIResponse<TypedBy> updateTermTypedByRelationship(String serverName,
                                                                         String userId,
                                                                         String guid,
                                                                         TypedBy termTypedByRelationship,
                                                                         boolean isReplace)
```
    Update a TypedBy relationship, which is a link between a spine attribute and its type.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    termTypedByRelationship - the TypedBy relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated TypedBy when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteTermTypedByRelationship
```
public SubjectAreaOMASAPIResponse<TypedBy> deleteTermTypedByRelationship(String serverName,
                                                                         String userId,
                                                                         String guid,
                                                                         Boolean isPurge)
```
    Delete a TypedBy relationship, which is a link between a spine attribute and its type.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TypedBy relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermTypedByRelationship
```
public SubjectAreaOMASAPIResponse<TypedBy> restoreTermTypedByRelationship(String serverName,
                                                                          String userId,
                                                                          String guid)
```
    Restore a replacement term relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createIsARelationship
```
public SubjectAreaOMASAPIResponse<IsA> createIsARelationship(String serverName,
                                                             String userId,
                                                             IsA iSARelationship)
```
    Create a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    iSARelationship - the Isa relationship
    
    Returns:
    response, when successful contains the created iSARelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getIsARelationship
```
public SubjectAreaOMASAPIResponse<IsA> getIsARelationship(String serverName,
                                                          String userId,
                                                          String guid)
```
    Get a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the iSARelationship relationship to get
    
    Returns:
    response which when successful contains the iSARelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateIsARelationship
```
public SubjectAreaOMASAPIResponse<IsA> updateIsARelationship(String serverName,
                                                             String userId,
                                                             String guid,
                                                             IsA iSARelationship,
                                                             boolean isReplace)
```
    Update a Isa relationship, which is a link between a more general glossary term and a more specific definition.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    iSARelationship - the Isa relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated Isa when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteIsARelationship
```
public SubjectAreaOMASAPIResponse<IsA> deleteIsARelationship(String serverName,
                                                             String userId,
                                                             String guid,
                                                             Boolean isPurge)
```
    Delete a Isa relationship, which is a link between a more general glossary term and a more specific definition.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the Isa relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreIsARelationship
```
public SubjectAreaOMASAPIResponse<IsA> restoreIsARelationship(String serverName,
                                                              String userId,
                                                              String guid)
```
    Restore a is a relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermIsATypeOfRelationship
```
public SubjectAreaOMASAPIResponse<IsATypeOf> createTermIsATypeOfRelationship(String serverName,
                                                                             String userId,
                                                                             IsATypeOf termIsATypeOfRelationship)
```
    Create a termIsATypeOfRelationship relationship, which is an inheritance relationship between two spine objects.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    termIsATypeOfRelationship - the IsaTypeOf relationship
    
    Returns:
    response, when successful contains the created termIsATypeOfRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getTermIsATypeOfRelationship
```
public SubjectAreaOMASAPIResponse<IsATypeOf> getTermIsATypeOfRelationship(String serverName,
                                                                          String userId,
                                                                          String guid)
```
    Get a termIsATypeOfRelationship relationship, which is an inheritance relationship between two spine objects.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termIsATypeOfRelationship relationship to get
    
    Returns:
    response which when successful contains the termIsATypeOfRelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTermIsATypeOfRelationship
```
public SubjectAreaOMASAPIResponse<IsATypeOf> updateTermIsATypeOfRelationship(String serverName,
                                                                             String userId,
                                                                             String guid,
                                                                             IsATypeOf termIsATypeOfRelationship,
                                                                             boolean isReplace)
```
    Update a IsaTypeOf relationship, which is an inheritance relationship between two spine objects.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    termIsATypeOfRelationship - the IsaTypeOf relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated IsaTypeOf when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteIsATypeOfRelationship
```
public SubjectAreaOMASAPIResponse<IsATypeOf> deleteIsATypeOfRelationship(String serverName,
                                                                         String userId,
                                                                         String guid,
                                                                         Boolean isPurge)
```
    Delete a IsaTypeOf relationship, which is an inheritance relationship between two spine objects.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the IsaTypeOf relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermIsATypeOfRelationship
```
public SubjectAreaOMASAPIResponse<IsATypeOf> restoreTermIsATypeOfRelationship(String serverName,
                                                                              String userId,
                                                                              String guid)
```
    Restore a is IsaTypeOf relationship.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermCategorizationRelationship
```
public SubjectAreaOMASAPIResponse<Categorization> createTermCategorizationRelationship(String serverName,
                                                                                       String userId,
                                                                                       Categorization termCategorizationRelationship)
```
    Create a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    termCategorizationRelationship - the TermCategorizationRelationship relationship
    
    Returns:
    response, when successful contains the created termCategorizationRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getTermCategorizationRelationship
```
public SubjectAreaOMASAPIResponse<Categorization> getTermCategorizationRelationship(String serverName,
                                                                                    String userId,
                                                                                    String guid)
```
    Get a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termCategorizationRelationship relationship to get
    
    Returns:
    response which when successful contains the termCategorizationRelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTermCategorizationRelationship
```
public SubjectAreaOMASAPIResponse<Categorization> updateTermCategorizationRelationship(String serverName,
                                                                                       String userId,
                                                                                       String guid,
                                                                                       Categorization termCategorizationRelationship,
                                                                                       Boolean isReplace)
```
    Update a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    termCategorizationRelationship - the termCategorization relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated Isa when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - deleteTermCategorizationRelationship
```
public SubjectAreaOMASAPIResponse<Categorization> deleteTermCategorizationRelationship(String serverName,
                                                                                       String userId,
                                                                                       String guid,
                                                                                       Boolean isPurge)
```
    Delete a TermCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorizationRelationship relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermCategorizationRelationship
```
public SubjectAreaOMASAPIResponse<Categorization> restoreTermCategorizationRelationship(String serverName,
                                                                                        String userId,
                                                                                        String guid)
```
    Restore a TermCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
    Restore allows the deleted TermCategorization 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermCategorization Relationship to delete
    
    Returns:
    response which when successful contains the restored TermCategorization when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    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.
  - createTermAnchorRelationship
```
public SubjectAreaOMASAPIResponse<TermAnchor> createTermAnchorRelationship(String serverName,
                                                                           String userId,
                                                                           TermAnchor termAnchorRelationship)
```
    Create a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary. 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    termAnchorRelationship - the TermAnchorRelationship relationship
    
    Returns:
    response, when successful contains the created termAnchorRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getTermAnchorRelationship
```
public SubjectAreaOMASAPIResponse<TermAnchor> getTermAnchorRelationship(String serverName,
                                                                        String userId,
                                                                        String guid)
```
    Get a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termAnchor Relationship to get
    
    Returns:
    response which when successful contains the termAnchorRelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateTermAnchorRelationship
```
public SubjectAreaOMASAPIResponse<TermAnchor> updateTermAnchorRelationship(String serverName,
                                                                           String userId,
                                                                           String guid,
                                                                           TermAnchor termAnchor,
                                                                           Boolean isReplace)
```
    Update a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - guid of the TermAnchor relationship
    
    termAnchor - the termAnchor relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated termAnchor when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - deleteTermAnchorRelationship
```
public SubjectAreaOMASAPIResponse<TermAnchor> deleteTermAnchorRelationship(String serverName,
                                                                           String userId,
                                                                           String guid,
                                                                           Boolean isPurge)
```
    Delete a TermAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the TermAnchorRelationship relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermAnchorRelationship
```
public SubjectAreaOMASAPIResponse<TermAnchor> restoreTermAnchorRelationship(String serverName,
                                                                            String userId,
                                                                            String guid)
```
    Restore a TermAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.
    Restore allows the deleted TermAnchor 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    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 TermAnchor when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    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.
  - createCategoryAnchorRelationship
```
public SubjectAreaOMASAPIResponse<CategoryAnchor> createCategoryAnchorRelationship(String serverName,
                                                                                   String userId,
                                                                                   CategoryAnchor categoryAnchorRelationship)
```
    Create a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms 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.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    categoryAnchorRelationship - the CategoryAnchorRelationship relationship
    
    Returns:
    response, when successful contains the created categoryAnchorRelationship relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function not supported.
  - getCategoryAnchorRelationship
```
public SubjectAreaOMASAPIResponse<CategoryAnchor> getCategoryAnchorRelationship(String serverName,
                                                                                String userId,
                                                                                String guid)
```
    Get a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the categoryAnchor Relationship to get
    
    Returns:
    response which when successful contains the categoryAnchorRelationship relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateCategoryAnchorRelationship
```
public SubjectAreaOMASAPIResponse<CategoryAnchor> updateCategoryAnchorRelationship(String serverName,
                                                                                   String userId,
                                                                                   String guid,
                                                                                   CategoryAnchor categoryAnchor,
                                                                                   Boolean isReplace)
```
    Update a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows Categories to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - guid of the CategoryAnchor relationship
    
    categoryAnchor - the categoryAnchor relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated categoryAnchor when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - deleteCategoryAnchorRelationship
```
public SubjectAreaOMASAPIResponse<CategoryAnchor> deleteCategoryAnchorRelationship(String serverName,
                                                                                   String userId,
                                                                                   String guid,
                                                                                   Boolean isPurge)
```
    Delete a CategoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchorRelationship relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreCategoryAnchorRelationship
```
public SubjectAreaOMASAPIResponse<CategoryAnchor> restoreCategoryAnchorRelationship(String serverName,
                                                                                    String userId,
                                                                                    String guid)
```
    Restore a CategoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.
    Restore allows the deleted CategoryAnchor 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    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 CategoryAnchor when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    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.
  - createProjectScopeRelationship
```
public SubjectAreaOMASAPIResponse<ProjectScope> createProjectScopeRelationship(String serverName,
                                                                               String userId,
                                                                               ProjectScope projectScope)
```
    Create a projectScope relationship, which is a link between the project content and the project.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    projectScope - the Synonym relationship
    
    Returns:
    response, restored projectScope relationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
    
    FunctionNotSupportedException Function is not supported.
  - getProjectScopeRelationship
```
public SubjectAreaOMASAPIResponse<ProjectScope> getProjectScopeRelationship(String serverName,
                                                                            String userId,
                                                                            String guid)
```
    Get a projectScope relationship, which is a link between the project content and the project.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the termCategorization relationship to get
    
    Returns:
    response which when successful contains the termCategorization relationship with the requested guid when not successful the following Exception responses can occur
    
    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
  - updateProjectScopeRelationship
```
public SubjectAreaOMASAPIResponse<ProjectScope> updateProjectScopeRelationship(String serverName,
                                                                               String userId,
                                                                               String guid,
                                                                               ProjectScope projectScope,
                                                                               boolean isReplace)
```
    Update a ProjectScope relationship which is a link between the project content and the project.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - unique identifier of the relationship
    
    projectScope - the ProjectScope relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated ProjectScopeRelationship when not successful the following Exception responses can occur
    
    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
    
    ClassificationException Error processing a classification.
    
    FunctionNotSupportedException Function is not supported.
    
    StatusNotSupportedException A status value is not supported.
  - deleteProjectScopeRelationship
```
public SubjectAreaOMASAPIResponse<ProjectScope> deleteProjectScopeRelationship(String serverName,
                                                                               String userId,
                                                                               String guid,
                                                                               Boolean isPurge)
```
    Delete a ProjectScope relationship, which is a link between the project content and the project.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the ProjectScope relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreProjectScopeRelationship
```
public SubjectAreaOMASAPIResponse<ProjectScope> restoreProjectScopeRelationship(String serverName,
                                                                                String userId,
                                                                                String guid)
```
    Restore a projectScope relationship, which is a link between the project content and the project.
    Restore allows the deleted 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the relationship to restore
    
    Returns:
    response which when successful contains the restored relationship when not successful the following Exception responses can occur
    
    UnrecognizedGUIDException the supplied guid was not recognised
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    FunctionNotSupportedException Function is not supported.
    
    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.
    
    EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
    
    EntityNotPurgedException a hard delete was issued but the relationship was not purged
  - createCategoryHierarchyLink
```
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> createCategoryHierarchyLink(String serverName,
                                                                                     String userId,
                                                                                     CategoryHierarchyLink categoryHierarchyLink)
```
    Create a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    categoryHierarchyLink - the CategoryHierarchyLink relationship
    
    Returns:
    response, when successful contains the created categoryHierarchyLink relationship when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - getCategoryHierarchyLink
```
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> getCategoryHierarchyLink(String serverName,
                                                                                  String userId,
                                                                                  String guid)
```
    Get a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryHierarchyLink Relationship to get
    
    Returns:
    response which when successful contains the CategoryHierarchyLink relationship with the requested guid when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - updateCategoryHierarchyLink
```
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> updateCategoryHierarchyLink(String serverName,
                                                                                     String userId,
                                                                                     String guid,
                                                                                     CategoryHierarchyLink categoryHierarchyLink,
                                                                                     Boolean isReplace)
```
    Update a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - userId under which the request is performed
    
    guid - guid of the CategoryHierarchyLink relationship
    
    categoryHierarchyLink - the CategoryHierarchyLink relationship
    
    isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
    
    Returns:
    response, when successful contains the updated categoryHierarchyLink when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - deleteCategoryHierarchyLink
```
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> deleteCategoryHierarchyLink(String serverName,
                                                                                     String userId,
                                                                                     String guid,
                                                                                     Boolean isPurge)
```
    Delete a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryHierarchyLink relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - restoreCategoryHierarchyLink
```
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> restoreCategoryHierarchyLink(String serverName,
                                                                                      String userId,
                                                                                      String guid)
```
    Restore a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
    Restore allows the deleted CategoryHierarchyLink 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:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryHierarchyLink Relationship to delete
    
    Returns:
    response which when successful contains the restored CategoryHierarchyLink when not successful the following Exception responses can occur
    
    UserNotAuthorizedException the requesting user is not authorized to issue this request.
    
    InvalidParameterException one of the parameters is null or invalid.
    
    PropertyServerException Property server exception.
  - getSemanticAssignmentRelationship
```
public SubjectAreaOMASAPIResponse<SemanticAssignment> getSemanticAssignmentRelationship(String serverName,
                                                                                        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.
    Parameters:
    
    serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
    
    userId - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the SemanticAssignment relationship to get
    
    Returns:
    response which when successful contains the SemanticAssignment relationship with the requested guid when not successful the following Exception responses can occur
    
    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

Class SubjectAreaRelationshipRESTServices

Field Summary

Fields inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance

Methods inherited from class java.lang.Object

Constructor Detail

SubjectAreaRelationshipRESTServices

Method Detail

createTermHasARelationship

getTermHasARelationship

updateTermHasARelationship

deleteTermHasARelationship

restoreTermHasARelationship

createRelatedTerm

getRelatedTerm

updateRelatedTerm

deleteRelatedTerm

restoreRelatedTerm

createSynonym

getSynonymRelationship

updateSynonymRelationship

deleteSynonymRelationship

restoreSynonym

createAntonym

getAntonymRelationship

updateAntonymRelationship

deleteAntonymRelationship

restoreAntonym

createTranslation

getTranslationRelationship

updateTranslationRelationship

deleteTranslationRelationship

restoreTranslation

createUsedInContext

getUsedInContextRelationship

updateUsedInContextRelationship

deleteUsedInContextRelationship

restoreUsedInContext

createPreferredTerm

getPreferredTermRelationship

updatePreferredTermRelationship

deletePreferredTermRelationship

restorePreferredTerm

createValidValue

getValidValueRelationship

updateValidValueRelationship

deleteValidValueRelationship

restoreValidValue

createReplacementTerm

getReplacementTerm

updateReplacementTerm

deleteReplacementTerm

restoreReplacementTerm

createTermTypedByRelationship

getTermTypedByRelationship

updateTermTypedByRelationship

deleteTermTypedByRelationship

restoreTermTypedByRelationship

createIsARelationship

getIsARelationship

updateIsARelationship

deleteIsARelationship

restoreIsARelationship

createTermIsATypeOfRelationship

getTermIsATypeOfRelationship

updateTermIsATypeOfRelationship

deleteIsATypeOfRelationship

restoreTermIsATypeOfRelationship

createTermCategorizationRelationship

getTermCategorizationRelationship

updateTermCategorizationRelationship

deleteTermCategorizationRelationship

restoreTermCategorizationRelationship

createTermAnchorRelationship

getTermAnchorRelationship

updateTermAnchorRelationship

deleteTermAnchorRelationship

restoreTermAnchorRelationship