Package org.odpi.openmetadata.viewservices.glossaryauthor.services

Class GlossaryAuthorViewRelationshipRESTServices

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.

  • Constructor Details

    • GlossaryAuthorViewRelationshipRESTServices

      public GlossaryAuthorViewRelationshipRESTServices()
      Default constructor

  • Method Details

    • createTermHasARelationship

      public SubjectAreaOMASAPIResponse<HasA> createTermHasARelationship(String serverName, String userId, HasA termHasARelationship)
      Create a Hasa is the relationship between a spine object and a spine attribute. Note that this method does not error if the relationship ends are not spine objects or spine attributes. This allows the user to create terms then make them spine objects and spine attributes at a later stage.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      termHasARelationship - the HasA relationship
      Returns:
      response, when successful contains the created Hasa when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTermHasARelationship

      public SubjectAreaOMASAPIResponse<HasA> getTermHasARelationship(String serverName, String userId, String guid)
      Get a Term HAS A relationship
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the HasA 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateTermHasARelationship

      public SubjectAreaOMASAPIResponse<HasA> updateTermHasARelationship(String serverName, String userId, String guid, HasA termHasARelationship, boolean isReplace)
      Update a Hasa is the relationship between a spine object and a spine attribute.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      guid - guid of the HasA relationship
      termHasARelationship - the HasA relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated Hasa when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteTermHasARelationship

      public SubjectAreaOMASAPIResponse<HasA> deleteTermHasARelationship(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreTermHasARelationship

      public SubjectAreaOMASAPIResponse<HasA> restoreTermHasARelationship(String serverName, String userId, String guid)
      Restore a Term HAS A relationship.

      Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the relationship to restore
      Returns:
      response which when successful contains the restored relationship when not successful the following Exception responses can occur
      • UnrecognizedGUIDException the supplied guid was not recognised
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • FunctionNotSupportedException Function not supported.
      • InvalidParameterException one of the parameters is null or invalid.
      • MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
      • EntityNotDeletedException a soft delete was issued but the relationship was not deleted.

    • createRelatedTerm

      public SubjectAreaOMASAPIResponse<RelatedTerm> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getRelatedTerm

      public SubjectAreaOMASAPIResponse<RelatedTerm> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateRelatedTerm

      public SubjectAreaOMASAPIResponse<RelatedTerm> updateRelatedTerm(String serverName, String userId, String guid, 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
      guid - guid of the related term relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteRelatedTerm

      public SubjectAreaOMASAPIResponse<RelatedTerm> deleteRelatedTerm(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreRelatedTerm

      public SubjectAreaOMASAPIResponse<RelatedTerm> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createSynonym

      public SubjectAreaOMASAPIResponse<Synonym> createSynonym(String serverName, String userId, Synonym synonym)
      Create a synonym relationship, which is a link between glossary terms that have the same meaning.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      synonym - the synonym relationship
      Returns:
      response, when successful contains the created synonym when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getSynonym

      public SubjectAreaOMASAPIResponse<Synonym> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateSynonym

      public SubjectAreaOMASAPIResponse<Synonym> updateSynonym(String serverName, String userId, String guid, Synonym synonym, boolean isReplace)
      Update a synonym relationship, which is a link between glossary terms that have the same meaning.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      guid - guid of the Synonym relationship
      synonym - the synonym relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated synonym when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteSynonym

      public SubjectAreaOMASAPIResponse<Synonym> deleteSynonym(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreSynonym

      public SubjectAreaOMASAPIResponse<Synonym> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createAntonym

      public SubjectAreaOMASAPIResponse<Antonym> createAntonym(String serverName, String userId, Antonym antonym)
      Create an antonym relationship, which is a link between glossary terms that have the opposite 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getAntonym

      public SubjectAreaOMASAPIResponse<Antonym> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateAntonym

      public SubjectAreaOMASAPIResponse<Antonym> updateAntonym(String serverName, String userId, String guid, Antonym antonym, boolean isReplace)
      Update a antonym relationship, which is a link between glossary terms that have the opposite 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
      guid - guid of the Antonym relationship
      antonym - the antonym relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated antonym when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteAntonym

      public SubjectAreaOMASAPIResponse<Antonym> deleteAntonym(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreAntonym

      public SubjectAreaOMASAPIResponse<Antonym> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createTranslation

      public SubjectAreaOMASAPIResponse<Translation> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTranslation

      public SubjectAreaOMASAPIResponse<Translation> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateTranslation

      public SubjectAreaOMASAPIResponse<Translation> updateTranslation(String serverName, String userId, String guid, 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
      guid - guid of the Translation relationship
      categoryAnchor - the categoryAnchor relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated categoryAnchor when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteTranslation

      public SubjectAreaOMASAPIResponse<Translation> deleteTranslation(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreTranslation

      public SubjectAreaOMASAPIResponse<Translation> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createUsedInContext

      public SubjectAreaOMASAPIResponse<UsedInContext> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getUsedInContext

      public SubjectAreaOMASAPIResponse<UsedInContext> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateUsedInContext

      public SubjectAreaOMASAPIResponse<UsedInContext> updateUsedInContext(String serverName, String userId, String guid, 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
      guid - guid of the UsedInContext relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteUsedInContext

      public SubjectAreaOMASAPIResponse<UsedInContext> deleteUsedInContext(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreUsedInContext

      public SubjectAreaOMASAPIResponse<UsedInContext> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createPreferredTerm

      public SubjectAreaOMASAPIResponse<PreferredTerm> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getPreferredTerm

      public SubjectAreaOMASAPIResponse<PreferredTerm> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updatePreferredTerm

      public SubjectAreaOMASAPIResponse<PreferredTerm> updatePreferredTerm(String serverName, String userId, String guid, 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
      guid - guid of the PreferredTerm relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deletePreferredTerm

      public SubjectAreaOMASAPIResponse<PreferredTerm> deletePreferredTerm(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restorePreferredTerm

      public SubjectAreaOMASAPIResponse<PreferredTerm> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createValidValue

      public SubjectAreaOMASAPIResponse<ValidValue> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getValidValue

      public SubjectAreaOMASAPIResponse<ValidValue> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateValidValue

      public SubjectAreaOMASAPIResponse<ValidValue> updateValidValue(String serverName, String userId, String guid, 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
      guid - guid of the ValidValue relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteValidValue

      public SubjectAreaOMASAPIResponse<ValidValue> deleteValidValue(String serverName, String userId, String guid)
      Delete a ValidValue relationship, which is link between glossary terms where one defines one of the data values for the another.
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreValidValue

      public SubjectAreaOMASAPIResponse<ValidValue> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createReplacementTerm

      public SubjectAreaOMASAPIResponse<ReplacementTerm> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getReplacementTerm

      public SubjectAreaOMASAPIResponse<ReplacementTerm> getReplacementTerm(String serverName, String userId, String guid)
      Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the ReplacementTerm relationship to get
      Returns:
      response which when successful contains the 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateReplacementTerm

      public SubjectAreaOMASAPIResponse<ReplacementTerm> updateReplacementTerm(String serverName, String userId, String guid, 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
      guid - guid of the ReplacementTerm relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteReplacementTerm

      public SubjectAreaOMASAPIResponse<ReplacementTerm> deleteReplacementTerm(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreReplacementTerm

      public SubjectAreaOMASAPIResponse<ReplacementTerm> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createTermTYPEDBYRelationship

      public SubjectAreaOMASAPIResponse<TypedBy> createTermTYPEDBYRelationship(String serverName, String userId, TypedBy termTYPEDBYRelationship)
      Create a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      termTYPEDBYRelationship - the 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTermTYPEDBYRelationship

      public SubjectAreaOMASAPIResponse<TypedBy> getTermTYPEDBYRelationship(String serverName, String userId, String guid)
      Get a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the TypedBy 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateTermTYPEDBYRelationship

      public SubjectAreaOMASAPIResponse<TypedBy> updateTermTYPEDBYRelationship(String serverName, String userId, String guid, TypedBy 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
      guid - guid of the TypedBy relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteTermTYPEDBYRelationship

      public SubjectAreaOMASAPIResponse<TypedBy> deleteTermTYPEDBYRelationship(String serverName, String userId, String guid)
      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 TypedBy relationship to 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreTermTYPEDBYRelationship

      public SubjectAreaOMASAPIResponse<TypedBy> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createIsaRelationship

      public SubjectAreaOMASAPIResponse<IsA> createIsaRelationship(String serverName, String userId, IsA 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 Isa when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getIsARelationship

      public SubjectAreaOMASAPIResponse<IsA> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateIsARelationship

      public SubjectAreaOMASAPIResponse<IsA> updateIsARelationship(String serverName, String userId, String guid, IsA 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
      guid - guid of the IsA Relationship
      IsARelationship - the IsA Relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated Isa when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteIsARelationship

      public SubjectAreaOMASAPIResponse<IsA> deleteIsARelationship(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreIsARelationship

      public SubjectAreaOMASAPIResponse<IsA> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createTermIsATypeOfDeprecated

      public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> createTermIsATypeOfDeprecated(String serverName, String userId, IsATypeOfDeprecated TermIsATypeOfDeprecated)
      Deprecated.
      IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
      Create a TermIsATypeOfDeprecated 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
      TermIsATypeOfDeprecated - the TermIsATypeOfDeprecated relationship
      Returns:
      response, when successful contains the created TermIsATypeOfDeprecated when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTermIsATypeOfDeprecated

      public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> getTermIsATypeOfDeprecated(String serverName, String userId, String guid)
      Deprecated.
      IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
      Get a TermIsATypeOfDeprecated relationship, which is an inheritance relationship between two spine objects.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateTermIsATypeOfDeprecated

      public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> updateTermIsATypeOfDeprecated(String serverName, String userId, String guid, IsATypeOfDeprecated TermIsATypeOfDeprecated, boolean isReplace)
      Deprecated.
      IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
      Update a TermIsATypeOfDeprecated relationship, which is an inheritance relationship between two spine objects.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      guid - guid of the IsaTypeOf relationship
      TermIsATypeOfDeprecated - the TermIsATypeOfDeprecated 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 TermIsATypeOfDeprecated when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteTermIsATypeOfDeprecated

      public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> deleteTermIsATypeOfDeprecated(String serverName, String userId, String guid)
      Deprecated.
      IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
      Delete a TermIsATypeOfDeprecated relationship, which is an inheritance relationship between two spine objects.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to delete
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreTermIsATypeOfDeprecated

      public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> restoreTermIsATypeOfDeprecated(String serverName, String userId, String guid)
      Deprecated.
      IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead. 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.
      Restore a TermIsATypeOfDeprecated 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 relationship to restore
      Returns:
      response which when successful contains the restored relationship when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createIsATypeOf

      public SubjectAreaOMASAPIResponse<IsATypeOf> createIsATypeOf(String serverName, String userId, IsATypeOf IsATypeOf)
      Create a IsATypeOf relationship, which is an inheritance relationship between two spine objects.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      IsATypeOf - the IsATypeOf relationship
      Returns:
      response, when successful contains the created IsATypeOf when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getIsATypeOf

      public SubjectAreaOMASAPIResponse<IsATypeOf> getIsATypeOf(String serverName, String userId, String guid)
      Get a IsATypeOf relationship, which is an inheritance relationship between two spine objects.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateIsATypeOf

      public SubjectAreaOMASAPIResponse<IsATypeOf> updateIsATypeOf(String serverName, String userId, String guid, IsATypeOf IsATypeOf, boolean isReplace)
      Update a IsATypeOf relationship, which is an inheritance relationship between two spine objects.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      guid - guid of the IsaTypeOf relationship
      IsATypeOf - the IsATypeOf relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated IsATypeOf when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteIsATypeOf

      public SubjectAreaOMASAPIResponse<IsATypeOf> deleteIsATypeOf(String serverName, String userId, String guid)
      Delete a IsATypeOf relationship, which is an inheritance relationship between two spine objects.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the IsaTypeOf relationship to delete
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreIsATypeOf

      public SubjectAreaOMASAPIResponse<IsATypeOf> restoreIsATypeOf(String serverName, String userId, String guid)
      Restore a IsATypeOf 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createTermCategorization

      public SubjectAreaOMASAPIResponse<Categorization> createTermCategorization(String serverName, String userId, Categorization 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTermCategorization

      public SubjectAreaOMASAPIResponse<Categorization> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateTermCategorization

      public SubjectAreaOMASAPIResponse<Categorization> updateTermCategorization(String serverName, String userId, String guid, Categorization 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
      guid - guid of the TermCategorization relationship
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteTermCategorization

      public SubjectAreaOMASAPIResponse<Categorization> deleteTermCategorization(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreTermCategorization

      public SubjectAreaOMASAPIResponse<Categorization> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getTermAnchor

      public SubjectAreaOMASAPIResponse<TermAnchor> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getCategoryAnchor

      public SubjectAreaOMASAPIResponse<CategoryAnchor> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createProjectScope

      public SubjectAreaOMASAPIResponse<ProjectScope> createProjectScope(String serverName, String userId, ProjectScope 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getProjectScope

      public SubjectAreaOMASAPIResponse<ProjectScope> 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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateProjectScope

      public SubjectAreaOMASAPIResponse<ProjectScope> updateProjectScope(String serverName, String userId, String guid, ProjectScope 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
      guid - guid of the ProjectScope relationship
      projectScope - the projectScope relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated projectScope when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteProjectScope

      public SubjectAreaOMASAPIResponse<ProjectScope> deleteProjectScope(String serverName, String userId, String guid)
      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
      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.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreProjectScope

      public SubjectAreaOMASAPIResponse<ProjectScope> 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
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • createCategoryHierarchyLink

      public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> createCategoryHierarchyLink(String serverName, String userId, CategoryHierarchyLink categoryHierarchyLink)
      Create a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      categoryHierarchyLink - the CategoryHierarchyLink relationship
      Returns:
      response, when successful contains the created categoryHierarchyLink relationship when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getCategoryHierarchyLink

      public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> getCategoryHierarchyLink(String serverName, String userId, String guid)
      Get a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to get
      Returns:
      response which when successful contains the CategoryHierarchyLink relationship with the requested guid when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • updateCategoryHierarchyLink

      public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> updateCategoryHierarchyLink(String serverName, String userId, String guid, CategoryHierarchyLink categoryHierarchyLink, Boolean isReplace)
      Update a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - userId under which the request is performed
      guid - guid of the CategoryHierarchyLink relationship
      categoryHierarchyLink - the CategoryHierarchyLink relationship
      isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.
      Returns:
      response, when successful contains the updated categoryHierarchyLink when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • deleteCategoryHierarchyLink

      public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> deleteCategoryHierarchyLink(String serverName, String userId, String guid)
      Delete a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink relationship to delete
      Returns:
      response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • restoreCategoryHierarchyLink

      public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> restoreCategoryHierarchyLink(String serverName, String userId, String guid)
      Restore a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.

      Restore allows the deleted CategoryHierarchyLink Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the CategoryHierarchyLink Relationship to delete
      Returns:
      response which when successful contains the restored CategoryHierarchyLink when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.

    • getSemanticAssignmentRelationship

      public SubjectAreaOMASAPIResponse<SemanticAssignment> getSemanticAssignmentRelationship(String serverName, String userId, String guid)
      Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
      Parameters:
      serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant
      userId - unique identifier for requesting user, under which the request is performed
      guid - guid of the SemanticAssignment relationship to get
      Returns:
      response which when successful contains the SemanticAssignment relationship with the requested guid when not successful the following Exception responses can occur
      • UserNotAuthorizedException the requesting user is not authorized to issue this request.
      • InvalidParameterException one of the parameters is null or invalid.
      • PropertyServerException Property server exception.