GlossaryAuthorViewRelationshipRESTServices (glossary-author-view-server 1.6 API)

java.lang.Object
- org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView
- - org.odpi.openmetadata.viewservices.glossaryauthor.services.GlossaryAuthorViewRelationshipRESTServices

```
public class GlossaryAuthorViewRelationshipRESTServices
extends BaseGlossaryAuthorView
```
The GlossaryAuthorViewRelationshipRESTServices provides the org.odpi.openmetadata.viewservices.glossaryauthor.services implementation of the Glossary Author Open Metadata View Service (OMVS). This interface provides view Relationship authoring interfaces for subject area experts.

Field Summary
- Fields inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView
  instanceHandler, restCallLogger

Constructor Summary

Constructors
Constructor and Description

GlossaryAuthorViewRelationshipRESTServices()
Default constructor

Constructors
Constructor and Description
`GlossaryAuthorViewRelationshipRESTServices()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SubjectAreaOMASAPIResponse`	`createAntonym(String serverName, String userId, Antonym antonym)` Create an antonym relationship, which is a link between glossary terms that have the opposite meanings.
`SubjectAreaOMASAPIResponse`	`createCategoryAnchor(String serverName, String userId, CategoryAnchorRelationship categoryAnchor)` Create a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`createIsaRelationship(String serverName, String userId, ISARelationship ISARelationship)` Create iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse`	`createPreferredTerm(String serverName, String userId, PreferredTerm preferredTerm)` Create 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`	`createProjectScope(String serverName, String userId, ProjectScopeRelationship projectScope)` Create a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse`	`createRelatedTerm(String serverName, String userId, RelatedTerm relatedTerm)` Create a Related Term is a link between two similar Terms.
`SubjectAreaOMASAPIResponse`	`createReplacementTerm(String serverName, String userId, ReplacementTerm replacementTerm)` Create a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse`	`createSynonym(String serverName, String userId, Synonym synonym)` Create a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`createTermAnchor(String serverName, String userId, TermAnchorRelationship termAnchor)` Create a termAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`createTermCategorization(String serverName, String userId, TermCategorizationRelationship termCategorization)` Create a termCategorization Relationship.
`SubjectAreaOMASAPIResponse`	`createTermHASARelationship(String serverName, String userId, TermHASARelationship termHASARelationship)` Create a TermHASARelationship is the relationship between a spine object and a spine attribute.
`SubjectAreaOMASAPIResponse`	`createTermISATypeOFRelationship(String serverName, String userId, TermISATypeOFRelationship termISATypeOFRelationship)` Create a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse`	`createTermTYPEDBYRelationship(String serverName, String userId, TermTYPEDBYRelationship termTYPEDBYRelationship)` Create a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse`	`createTranslation(String serverName, String userId, Translation categoryAnchor)` Create a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse`	`createUsedInContext(String serverName, String userId, UsedInContext usedInContext)` Create a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse`	`createValidValue(String serverName, String userId, ValidValue validValue)` Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`SubjectAreaOMASAPIResponse`	`deleteAntonym(String serverName, String userId, String guid, Boolean isPurge)` Delete a Antonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`deleteCategoryAnchor(String serverName, String userId, String guid, Boolean isPurge)` Delete a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`deleteISARelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse`	`deletePreferredTerm(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`	`deleteProjectScope(String serverName, String userId, String guid, Boolean isPurge)` Delete a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse`	`deleteRelatedTerm(String serverName, String userId, String guid, Boolean isPurge)` Delete a Related Term is a link between two similar Terms.
`SubjectAreaOMASAPIResponse`	`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`	`deleteSynonym(String serverName, String userId, String guid, Boolean isPurge)` Delete a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`deleteTermAnchor(String serverName, String userId, String guid, Boolean isPurge)` Delete a termAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`deleteTermCategorization(String serverName, String userId, String guid, Boolean isPurge)` Delete a termCategorization Relationship.
`SubjectAreaOMASAPIResponse`	`deleteTermHASARelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Term HAS A relationship
`SubjectAreaOMASAPIResponse`	`deleteTermISATypeOFRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse`	`deleteTermTYPEDBYRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse`	`deleteTranslation(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`	`deleteUsedInContext(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`	`deleteValidValue(String serverName, String userId, String guid, Boolean isPurge)` Delete a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`SubjectAreaOMASAPIResponse`	`getAntonym(String serverName, String userId, String guid)` Get a Antonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`getCategoryAnchor(String serverName, String userId, String guid)` Get a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`getISARelationship(String serverName, String userId, String guid)` Get iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse`	`getPreferredTerm(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`	`getProjectScope(String serverName, String userId, String guid)` Get a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse`	`getRelatedTerm(String serverName, String userId, String guid)` Get a Related Term is a link between two similar Terms.
`SubjectAreaOMASAPIResponse`	`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`	`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`	`getSynonym(String serverName, String userId, String guid)` Get a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`getTermAnchor(String serverName, String userId, String guid)` Get a termAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`getTermCategorization(String serverName, String userId, String guid)` Get a termCategorization Relationship.
`SubjectAreaOMASAPIResponse`	`getTermHASARelationship(String serverName, String userId, String guid)` Get a Term HAS A relationship
`SubjectAreaOMASAPIResponse`	`getTermISATypeOFRelationship(String serverName, String userId, String guid)` Get a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse`	`getTermTYPEDBYRelationship(String serverName, String userId, String guid)` Get a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse`	`getTranslation(String serverName, String userId, String guid)` Get a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse`	`getUsedInContext(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`	`getValidValue(String serverName, String userId, String guid)` Get a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`SubjectAreaOMASAPIResponse`	`restoreAntonym(String serverName, String userId, String guid)` Restore Antonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`restoreCategoryAnchor(String serverName, String userId, String guid)` Restore a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`restoreISARelationship(String serverName, String userId, String guid)` Restore iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse`	`restorePreferredTerm(String serverName, String userId, String guid)` Restore 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`	`restoreProjectScope(String serverName, String userId, String guid)` Restore a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse`	`restoreRelatedTerm(String serverName, String userId, String guid)` Restore Related Term is a link between two similar Terms.
`SubjectAreaOMASAPIResponse`	`restoreReplacementTerm(String serverName, String userId, String guid)` Restore a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse`	`restoreSynonym(String serverName, String userId, String guid)` Restore synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`restoreTermAnchor(String serverName, String userId, String guid)` Restore a termAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`restoreTermCategorization(String serverName, String userId, String guid)` Restore a termCategorization Relationship.
`SubjectAreaOMASAPIResponse`	`restoreTermHASARelationship(String serverName, String userId, String guid)` Restore a Term HAS A relationship.
`SubjectAreaOMASAPIResponse`	`restoreTermISATypeOFRelationship(String serverName, String userId, String guid)` Restore a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse`	`restoreTermTYPEDBYRelationship(String serverName, String userId, String guid)` Restore a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse`	`restoreTranslation(String serverName, String userId, String guid)` Restore a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse`	`restoreUsedInContext(String serverName, String userId, String guid)` Restore a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse`	`restoreValidValue(String serverName, String userId, String guid)` Restore a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
`SubjectAreaOMASAPIResponse`	`updateAntonym(String serverName, String userId, Antonym antonym, boolean isReplace)` Update a antonym relationship, which is a link between glossary terms that have the opposite meanings.
`SubjectAreaOMASAPIResponse`	`updateCategoryAnchor(String serverName, String userId, CategoryAnchorRelationship categoryAnchor, boolean isReplace)` Update a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`updateISARelationship(String serverName, String userId, ISARelationship ISARelationship, boolean isReplace)` Update iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse`	`updatePreferredTerm(String serverName, String userId, PreferredTerm preferredTerm, 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`	`updateProjectScope(String serverName, String userId, ProjectScopeRelationship projectScope, boolean isReplace)` Update a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse`	`updateRelatedTerm(String serverName, String userId, RelatedTerm relatedTerm, boolean isReplace)` Update a Related Term is a link between two similar Terms.
`SubjectAreaOMASAPIResponse`	`updateReplacementTerm(String serverName, String userId, ReplacementTerm replacementTerm, boolean isReplace)` Update a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse`	`updateSynonym(String serverName, String userId, Synonym synonym, boolean isReplace)` Update a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse`	`updateTermAnchor(String serverName, String userId, TermAnchorRelationship termAnchor, boolean isReplace)` Update a termAnchor Relationship.
`SubjectAreaOMASAPIResponse`	`updateTermCategorization(String serverName, String userId, TermCategorizationRelationship termCategorization, boolean isReplace)` Update a termCategorization Relationship.
`SubjectAreaOMASAPIResponse`	`updateTermHASARelationship(String serverName, String userId, TermHASARelationship termHASARelationship, boolean isReplace)` Update a TermHASARelationship is the relationship between a spine object and a spine attribute.
`SubjectAreaOMASAPIResponse`	`updateTermISATypeOFRelationship(String serverName, String userId, TermISATypeOFRelationship termISATypeOFRelationship, boolean isReplace)` Update a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse`	`updateTermTYPEDBYRelationship(String serverName, String userId, TermTYPEDBYRelationship termTYPEDBYRelationship, boolean isReplace)` Update a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse`	`updateTranslation(String serverName, String userId, Translation categoryAnchor, boolean isReplace)` Update a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse`	`updateUsedInContext(String serverName, String userId, UsedInContext usedInContext, 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`	`updateValidValue(String serverName, String userId, ValidValue validValue, boolean isReplace)` Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.

Methods inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView
getResponseForError

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

- Constructor Detail
  - GlossaryAuthorViewRelationshipRESTServices
```
public GlossaryAuthorViewRelationshipRESTServices()
```
    Default constructor
- Method Detail
  - createTermHASARelationship
```
public SubjectAreaOMASAPIResponse createTermHASARelationship(String serverName,
                                                             String userId,
                                                             TermHASARelationship termHASARelationship)
```
    Create a TermHASARelationship 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 TermHASARelationship 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 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 updateTermHASARelationship(String serverName,
                                                             String userId,
                                                             TermHASARelationship termHASARelationship,
                                                             boolean isReplace)
```
    Update a TermHASARelationship 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
    
    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 TermHASARelationship 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 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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermHASARelationship
```
public SubjectAreaOMASAPIResponse 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createRelatedTerm
```
public SubjectAreaOMASAPIResponse createRelatedTerm(String serverName,
                                                    String userId,
                                                    RelatedTerm relatedTerm)
```
    Create 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
    
    relatedTerm - the Related Term relationship
    
    Returns:
    response, when successful contains the created 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.
    
    FunctionNotSupportedException Function not supported.
    
    ClassificationException Error processing a classification.
    
    StatusNotSupportedException A status value is not supported.
  - getRelatedTerm
```
public SubjectAreaOMASAPIResponse getRelatedTerm(String serverName,
                                                 String userId,
                                                 String guid)
```
    Get 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 - 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 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
  - updateRelatedTerm
```
public SubjectAreaOMASAPIResponse updateRelatedTerm(String serverName,
                                                    String userId,
                                                    RelatedTerm relatedTerm,
                                                    boolean isReplace)
```
    Update 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
    
    relatedTerm - 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 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 deleteRelatedTerm(String serverName,
                                                    String userId,
                                                    String guid,
                                                    Boolean isPurge)
```
    Delete 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 - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the RelatedTerm relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreRelatedTerm
```
public SubjectAreaOMASAPIResponse restoreRelatedTerm(String serverName,
                                                     String userId,
                                                     String guid)
```
    Restore Related Term is a link between two similar Terms. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createSynonym
```
public SubjectAreaOMASAPIResponse 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 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.
  - getSynonym
```
public SubjectAreaOMASAPIResponse getSynonym(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 Synonym 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
  - updateSynonym
```
public SubjectAreaOMASAPIResponse updateSynonym(String serverName,
                                                String userId,
                                                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
    
    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 synonym 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.
  - deleteSynonym
```
public SubjectAreaOMASAPIResponse deleteSynonym(String serverName,
                                                String userId,
                                                String guid,
                                                Boolean isPurge)
```
    Delete 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 Synonym relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreSynonym
```
public SubjectAreaOMASAPIResponse restoreSynonym(String serverName,
                                                 String userId,
                                                 String guid)
```
    Restore synonym relationship, which is a link between glossary terms that have the same meaning. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createAntonym
```
public SubjectAreaOMASAPIResponse createAntonym(String serverName,
                                                String userId,
                                                Antonym antonym)
```
    Create an antonym relationship, which is a link between glossary terms that have the opposite meanings.
    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 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.
  - getAntonym
```
public SubjectAreaOMASAPIResponse getAntonym(String serverName,
                                             String userId,
                                             String guid)
```
    Get a Antonym 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 Antonym 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
  - updateAntonym
```
public SubjectAreaOMASAPIResponse updateAntonym(String serverName,
                                                String userId,
                                                Antonym antonym,
                                                boolean isReplace)
```
    Update a antonym relationship, which is a link between glossary terms that have the opposite meanings.
    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
    
    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 antonym 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.
  - deleteAntonym
```
public SubjectAreaOMASAPIResponse deleteAntonym(String serverName,
                                                String userId,
                                                String guid,
                                                Boolean isPurge)
```
    Delete a Antonym 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 Antonym relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreAntonym
```
public SubjectAreaOMASAPIResponse restoreAntonym(String serverName,
                                                 String userId,
                                                 String guid)
```
    Restore Antonym relationship, which is a link between glossary terms that have the same meaning. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createTranslation
```
public SubjectAreaOMASAPIResponse createTranslation(String serverName,
                                                    String userId,
                                                    Translation categoryAnchor)
```
    Create 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 - userId under which the request is performed
    
    categoryAnchor - the categoryAnchor relationship
    
    Returns:
    response, when successful contains the created categoryAnchor 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.
  - getTranslation
```
public SubjectAreaOMASAPIResponse getTranslation(String serverName,
                                                 String userId,
                                                 String guid)
```
    Get 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 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
  - updateTranslation
```
public SubjectAreaOMASAPIResponse updateTranslation(String serverName,
                                                    String userId,
                                                    Translation categoryAnchor,
                                                    boolean isReplace)
```
    Update 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 - userId under which the request is performed
    
    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.
    
    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.
  - deleteTranslation
```
public SubjectAreaOMASAPIResponse deleteTranslation(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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTranslation
```
public SubjectAreaOMASAPIResponse restoreTranslation(String serverName,
                                                     String userId,
                                                     String guid)
```
    Restore a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createUsedInContext
```
public SubjectAreaOMASAPIResponse createUsedInContext(String serverName,
                                                      String userId,
                                                      UsedInContext usedInContext)
```
    Create 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
    
    usedInContext - the usedInContext relationship
    
    Returns:
    response, when successful contains the created usedInContext 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.
  - getUsedInContext
```
public SubjectAreaOMASAPIResponse getUsedInContext(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 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
  - updateUsedInContext
```
public SubjectAreaOMASAPIResponse updateUsedInContext(String serverName,
                                                      String userId,
                                                      UsedInContext usedInContext,
                                                      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
    
    usedInContext - 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 usedInContext 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.
  - deleteUsedInContext
```
public SubjectAreaOMASAPIResponse deleteUsedInContext(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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreUsedInContext
```
public SubjectAreaOMASAPIResponse restoreUsedInContext(String serverName,
                                                       String userId,
                                                       String guid)
```
    Restore a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createPreferredTerm
```
public SubjectAreaOMASAPIResponse createPreferredTerm(String serverName,
                                                      String userId,
                                                      PreferredTerm preferredTerm)
```
    Create 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
    
    preferredTerm - the preferredTerm relationship
    
    Returns:
    response, when successful contains the created preferredTerm 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.
  - getPreferredTerm
```
public SubjectAreaOMASAPIResponse getPreferredTerm(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 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
  - updatePreferredTerm
```
public SubjectAreaOMASAPIResponse updatePreferredTerm(String serverName,
                                                      String userId,
                                                      PreferredTerm preferredTerm,
                                                      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
    
    preferredTerm - 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 preferredTerm 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.
  - deletePreferredTerm
```
public SubjectAreaOMASAPIResponse deletePreferredTerm(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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restorePreferredTerm
```
public SubjectAreaOMASAPIResponse restorePreferredTerm(String serverName,
                                                       String userId,
                                                       String guid)
```
    Restore a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createValidValue
```
public SubjectAreaOMASAPIResponse createValidValue(String serverName,
                                                   String userId,
                                                   ValidValue validValue)
```
    Create a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    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
    
    validValue - the validValue relationship
    
    Returns:
    response, when successful contains the created validValue 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.
  - getValidValue
```
public SubjectAreaOMASAPIResponse getValidValue(String serverName,
                                                String userId,
                                                String guid)
```
    Get a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    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 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
  - updateValidValue
```
public SubjectAreaOMASAPIResponse updateValidValue(String serverName,
                                                   String userId,
                                                   ValidValue validValue,
                                                   boolean isReplace)
```
    Update a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    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
    
    validValue - 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 validValue 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.
  - deleteValidValue
```
public SubjectAreaOMASAPIResponse deleteValidValue(String serverName,
                                                   String userId,
                                                   String guid,
                                                   Boolean isPurge)
```
    Delete a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
    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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreValidValue
```
public SubjectAreaOMASAPIResponse restoreValidValue(String serverName,
                                                    String userId,
                                                    String guid)
```
    Restore a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createReplacementTerm
```
public SubjectAreaOMASAPIResponse createReplacementTerm(String serverName,
                                                        String userId,
                                                        ReplacementTerm replacementTerm)
```
    Create 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
    
    replacementTerm - the replacementTerm relationship
    
    Returns:
    response, when successful contains the created replacementTerm 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.
  - getReplacementTerm
```
public SubjectAreaOMASAPIResponse 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 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
  - updateReplacementTerm
```
public SubjectAreaOMASAPIResponse updateReplacementTerm(String serverName,
                                                        String userId,
                                                        ReplacementTerm replacementTerm,
                                                        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
    
    replacementTerm - 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 replacementTerm 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 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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreReplacementTerm
```
public SubjectAreaOMASAPIResponse restoreReplacementTerm(String serverName,
                                                         String userId,
                                                         String guid)
```
    Restore a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermTYPEDBYRelationship
```
public SubjectAreaOMASAPIResponse createTermTYPEDBYRelationship(String serverName,
                                                                String userId,
                                                                TermTYPEDBYRelationship 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 termTYPEDBYRelationship relationship
    
    Returns:
    response, when successful contains the created termTYPEDBYRelationship 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.
  - getTermTYPEDBYRelationship
```
public SubjectAreaOMASAPIResponse 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 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
  - updateTermTYPEDBYRelationship
```
public SubjectAreaOMASAPIResponse updateTermTYPEDBYRelationship(String serverName,
                                                                String userId,
                                                                TermTYPEDBYRelationship termTYPEDBYRelationship,
                                                                boolean isReplace)
```
    Update 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 termTYPEDBYRelationship 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 termTYPEDBYRelationship 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 deleteTermTYPEDBYRelationship(String serverName,
                                                                String userId,
                                                                String guid,
                                                                Boolean isPurge)
```
    Delete 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 delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermTYPEDBYRelationship
```
public SubjectAreaOMASAPIResponse restoreTermTYPEDBYRelationship(String serverName,
                                                                 String userId,
                                                                 String guid)
```
    Restore a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createIsaRelationship
```
public SubjectAreaOMASAPIResponse createIsaRelationship(String serverName,
                                                        String userId,
                                                        ISARelationship ISARelationship)
```
    Create 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 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.
  - getISARelationship
```
public SubjectAreaOMASAPIResponse getISARelationship(String serverName,
                                                     String userId,
                                                     String guid)
```
    Get 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 ISA 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
  - updateISARelationship
```
public SubjectAreaOMASAPIResponse updateISARelationship(String serverName,
                                                        String userId,
                                                        ISARelationship ISARelationship,
                                                        boolean isReplace)
```
    Update 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
    
    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 ISARelationship 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 deleteISARelationship(String serverName,
                                                        String userId,
                                                        String guid,
                                                        Boolean isPurge)
```
    Delete 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 ISA Relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreISARelationship
```
public SubjectAreaOMASAPIResponse restoreISARelationship(String serverName,
                                                         String userId,
                                                         String guid)
```
    Restore iSARelationship relationship, which is a link between a more general glossary term and a more specific definition. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermISATypeOFRelationship
```
public SubjectAreaOMASAPIResponse createTermISATypeOFRelationship(String serverName,
                                                                  String userId,
                                                                  TermISATypeOFRelationship 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 termISATypeOFRelationship relationship
    
    Returns:
    response, when successful contains the created termISATypeOFRelationship 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.
  - getTermISATypeOFRelationship
```
public SubjectAreaOMASAPIResponse 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 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
  - updateTermISATypeOFRelationship
```
public SubjectAreaOMASAPIResponse updateTermISATypeOFRelationship(String serverName,
                                                                  String userId,
                                                                  TermISATypeOFRelationship termISATypeOFRelationship,
                                                                  boolean isReplace)
```
    Update 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 termISATypeOFRelationship 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 termISATypeOFRelationship 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.
  - deleteTermISATypeOFRelationship
```
public SubjectAreaOMASAPIResponse deleteTermISATypeOFRelationship(String serverName,
                                                                  String userId,
                                                                  String guid,
                                                                  Boolean isPurge)
```
    Delete 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 delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermISATypeOFRelationship
```
public SubjectAreaOMASAPIResponse restoreTermISATypeOFRelationship(String serverName,
                                                                   String userId,
                                                                   String guid)
```
    Restore a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermCategorization
```
public SubjectAreaOMASAPIResponse createTermCategorization(String serverName,
                                                           String userId,
                                                           TermCategorizationRelationship termCategorization)
```
    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
    
    termCategorization - the termCategorization relationship
    
    Returns:
    response, when successful contains the created termCategorization 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.
  - getTermCategorization
```
public SubjectAreaOMASAPIResponse getTermCategorization(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 TermCategorization 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
  - updateTermCategorization
```
public SubjectAreaOMASAPIResponse updateTermCategorization(String serverName,
                                                           String userId,
                                                           TermCategorizationRelationship termCategorization,
                                                           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
    
    termCategorization - 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 termCategorization 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.
  - deleteTermCategorization
```
public SubjectAreaOMASAPIResponse deleteTermCategorization(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 TermCategorization relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermCategorization
```
public SubjectAreaOMASAPIResponse restoreTermCategorization(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 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createTermAnchor
```
public SubjectAreaOMASAPIResponse createTermAnchor(String serverName,
                                                   String userId,
                                                   TermAnchorRelationship termAnchor)
```
    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 Glossary Author OMVS 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 Glossary Author OMVS (or the Subject Area OMAS) or to recreate the TermAnchorRelationship 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
    
    termAnchor - the termAnchor relationship
    
    Returns:
    response, when successful contains the created termAnchor 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.
  - getTermAnchor
```
public SubjectAreaOMASAPIResponse getTermAnchor(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 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
  - updateTermAnchor
```
public SubjectAreaOMASAPIResponse updateTermAnchor(String serverName,
                                                   String userId,
                                                   TermAnchorRelationship 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
    
    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.
    
    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.
  - deleteTermAnchor
```
public SubjectAreaOMASAPIResponse deleteTermAnchor(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 TermAnchor relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreTermAnchor
```
public SubjectAreaOMASAPIResponse restoreTermAnchor(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 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createCategoryAnchor
```
public SubjectAreaOMASAPIResponse createCategoryAnchor(String serverName,
                                                       String userId,
                                                       CategoryAnchorRelationship categoryAnchor)
```
    Create a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows Categories to be owned by a Glossary. Categories created using the Glossary Author OMVS 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 Categories that have not been created via the Glossary Author OMVS (or the Subject Area OMAS) or to recreate the CategoryAnchorRelationship 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
    
    categoryAnchor - the categoryAnchor relationship
    
    Returns:
    response, when successful contains the created categoryAnchor 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.
  - getCategoryAnchor
```
public SubjectAreaOMASAPIResponse getCategoryAnchor(String serverName,
                                                    String userId,
                                                    String guid)
```
    Get 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 - 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 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
  - updateCategoryAnchor
```
public SubjectAreaOMASAPIResponse updateCategoryAnchor(String serverName,
                                                       String userId,
                                                       CategoryAnchorRelationship 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
    
    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.
    
    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.
  - deleteCategoryAnchor
```
public SubjectAreaOMASAPIResponse deleteCategoryAnchor(String serverName,
                                                       String userId,
                                                       String guid,
                                                       Boolean isPurge)
```
    Delete 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 - unique identifier for requesting user, under which the request is performed
    
    guid - guid of the CategoryAnchor relationship to delete
    
    isPurge - true indicates a hard delete, false is a soft delete.
    
    Returns:
    response which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreCategoryAnchor
```
public SubjectAreaOMASAPIResponse restoreCategoryAnchor(String serverName,
                                                        String userId,
                                                        String guid)
```
    Restore a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows Categories to be owned by a Glossary. 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - createProjectScope
```
public SubjectAreaOMASAPIResponse createProjectScope(String serverName,
                                                     String userId,
                                                     ProjectScopeRelationship projectScope)
```
    Create a project scope 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 projectScope relationship
    
    Returns:
    response, when successful contains the created projectScope 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.
  - getProjectScope
```
public SubjectAreaOMASAPIResponse getProjectScope(String serverName,
                                                  String userId,
                                                  String guid)
```
    Get a project scope 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 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
  - updateProjectScope
```
public SubjectAreaOMASAPIResponse updateProjectScope(String serverName,
                                                     String userId,
                                                     ProjectScopeRelationship projectScope,
                                                     boolean isReplace)
```
    Update a project scope 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 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 projectScope 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.
  - deleteProjectScope
```
public SubjectAreaOMASAPIResponse deleteProjectScope(String serverName,
                                                     String userId,
                                                     String guid,
                                                     Boolean isPurge)
```
    Delete a project scope 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 which when successful contains the term has a relationship with the requested guid 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - restoreProjectScope
```
public SubjectAreaOMASAPIResponse restoreProjectScope(String serverName,
                                                      String userId,
                                                      String guid)
```
    Restore a project scope 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 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.
    
    GUIDNotPurgedException a hard delete was issued but the relationship was not purged
  - getSemanticAssignmentRelationship
```
public SubjectAreaOMASAPIResponse 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 GlossaryAuthorViewRelationshipRESTServices

Field Summary

Fields inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.viewservices.glossaryauthor.services.BaseGlossaryAuthorView

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryAuthorViewRelationshipRESTServices

Method Detail

createTermHASARelationship

getTermHASARelationship

updateTermHASARelationship

deleteTermHASARelationship

restoreTermHASARelationship

createRelatedTerm

getRelatedTerm

updateRelatedTerm

deleteRelatedTerm

restoreRelatedTerm

createSynonym

getSynonym

updateSynonym

deleteSynonym

restoreSynonym

createAntonym

getAntonym

updateAntonym

deleteAntonym

restoreAntonym

createTranslation

getTranslation

updateTranslation

deleteTranslation

restoreTranslation

createUsedInContext

getUsedInContext

updateUsedInContext

deleteUsedInContext

restoreUsedInContext

createPreferredTerm

getPreferredTerm

updatePreferredTerm

deletePreferredTerm

restorePreferredTerm

createValidValue

getValidValue

updateValidValue

deleteValidValue

restoreValidValue

createReplacementTerm

getReplacementTerm

updateReplacementTerm

deleteReplacementTerm

restoreReplacementTerm

createTermTYPEDBYRelationship

getTermTYPEDBYRelationship

updateTermTYPEDBYRelationship

deleteTermTYPEDBYRelationship

restoreTermTYPEDBYRelationship

createIsaRelationship

getISARelationship

updateISARelationship

deleteISARelationship

restoreISARelationship

createTermISATypeOFRelationship

getTermISATypeOFRelationship

updateTermISATypeOFRelationship

deleteTermISATypeOFRelationship

restoreTermISATypeOFRelationship

createTermCategorization

getTermCategorization

updateTermCategorization

deleteTermCategorization

restoreTermCategorization

createTermAnchor

getTermAnchor

updateTermAnchor

deleteTermAnchor

restoreTermAnchor