java.lang.Object
- org.odpi.openmetadata.viewservices.glossaryauthor.server.GlossaryAuthorViewRelationshipRESTResource

```
@RestController
@RequestMapping("/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/relationships")
public class GlossaryAuthorViewRelationshipRESTResource
extends Object
```
The GlossaryAuthorRESTServicesInstance provides the org.odpi.openmetadata.viewservices.glossaryauthor.server implementation of the Glossary Author Open Metadata View Service (OMVS) for relationships. This interface provides relationship authoring interfaces for subject area experts.

Constructor Summary

Constructors
Constructor Description

GlossaryAuthorViewRelationshipRESTResource()
Default constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`SubjectAreaOMASAPIResponse<Antonym>`	`createAntonym(String serverName, String userId, Antonym antonym)`	Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`createCategoryAnchor(String serverName, String userId, CategoryAnchor categoryAnchorRelationship)`	Create a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`createCategoryHierarchyLink(String serverName, String userId, CategoryHierarchyLink categoryHierarchyLink)`	Create a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`createiSARelationship(String serverName, String userId, IsA iSARelationship)`	Create a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`createIsATypeOf(String serverName, String userId, IsATypeOf IsATypeOf)`	Create a IsATypeOf Relationship relationship, which is an inheritance relationship between two spine objects.
`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.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`createProjectScopeRelationship(String serverName, String userId, ProjectScope projectScope)`	Create a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`createRelatedTerm(String serverName, String userId, RelatedTerm relatedTermRelationship)`	Create a RelatedTerm.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`createReplacementTerm(String serverName, String userId, ReplacementTerm replacementTerm)`	Create a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<Synonym>`	`createSynonym(String serverName, String userId, Synonym synonym)`	Create a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<TermAnchor>`	`createTermAnchor(String serverName, String userId, TermAnchor termAnchorRelationship)`	Create a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`createTermCategorization(String serverName, String userId, Categorization termCategorizationRelationship)`	Create a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`createTermHasARelationship(String serverName, String userId, HasA termHasARelationship)`	Create a TermHasARelationship is the relationship between a spine object and a spine attribute.
`SubjectAreaOMASAPIResponse<IsATypeOfDeprecated>`	`createTermIsATypeOfDeprecated(String serverName, String userId, IsATypeOfDeprecated TermIsATypeOfDeprecated)`	Deprecated. IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
`SubjectAreaOMASAPIResponse<TypedBy>`	`createtermTYPEDBYRelationship(String serverName, String userId, TypedBy termTYPEDBYRelationship)`	Create a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<Translation>`	`createTranslation(String serverName, String userId, Translation translation)`	Create a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`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.
`SubjectAreaOMASAPIResponse<ValidValue>`	`createValidValue(String serverName, String userId, ValidValue validValue)`	Create a validValue relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<Antonym>`	`deleteAntonymRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Antonym relationship
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`deleteCategoryAnchorRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a CategoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`deleteCategoryHierarchyLink(String serverName, String userId, String guid, Boolean isPurge)`	Delete a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`deleteIsATypeOf(String serverName, String userId, String guid, Boolean isPurge)`	Delete a IsATypeOf, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`deletePreferredTermRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`deleteProjectScopeRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Project scope relationship which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`deleteRelatedTerm(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Related Term relationship
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`deleteReplacementTermRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<Synonym>`	`deleteSynonymRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Synonym relationship
`SubjectAreaOMASAPIResponse<TermAnchor>`	`deleteTermAnchorRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a TermAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`deleteTermCategorizationRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a TermCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`deleteTermHasARelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Term HAS A relationship
`SubjectAreaOMASAPIResponse<IsA>`	`deleteTermIsARelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a IsARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<IsATypeOfDeprecated>`	`deleteTermIsATypeOfDeprecated(String serverName, String userId, String guid, Boolean isPurge)`	Deprecated. IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
`SubjectAreaOMASAPIResponse<Translation>`	`deleteTranslationRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a Translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<TypedBy>`	`deleteTypedByRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a TermTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`deleteUsedInContextRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`deleteValidValueRelationship(String serverName, String userId, String guid, Boolean isPurge)`	Delete a ValidValue relationship
`SubjectAreaOMASAPIResponse<Antonym>`	`getAntonymRelationship(String serverName, String userId, String guid)`	Get a antonym relationship
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`getCategoryAnchorRelationship(String serverName, String userId, String guid)`	Get a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`getCategoryHierarchyLink(String serverName, String userId, String guid)`	Get a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`getIsARelationship(String serverName, String userId, String guid)`	Get a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`getIsATypeOf(String serverName, String userId, String guid)`	Get a IsATypeOf Relationship, which is an inheritance relationship between two spine objects.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`getPreferredTermRelationship(String serverName, String userId, String guid)`	Get a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`getProjectScopeRelationship(String serverName, String userId, String guid)`	Get a project scope relationship, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`getRelatedTerm(String serverName, String userId, String guid)`	Get a related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`getReplacementTermRelationship(String serverName, String userId, String guid)`	Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`SubjectAreaOMASAPIResponse<SemanticAssignment>`	`getSemanticAssignmentRelationship(String serverName, String userId, String guid)`	Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
`SubjectAreaOMASAPIResponse<Synonym>`	`getSynonymRelationship(String serverName, String userId, String guid)`	Get a synonym relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<TermAnchor>`	`getTermAnchorRelationship(String serverName, String userId, String guid)`	Get a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`getTermCategorizationRelationship(String serverName, String userId, String guid)`	Get a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`getTermHasARelationship(String serverName, String userId, String guid)`	Get a Term HAS A relationship
`SubjectAreaOMASAPIResponse<IsATypeOfDeprecated>`	`getTermIsATypeOfDeprecated(String serverName, String userId, String guid)`	Deprecated. IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
`SubjectAreaOMASAPIResponse<Translation>`	`getTranslationRelationship(String serverName, String userId, String guid)`	Get a translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<TypedBy>`	`getTYPEDBYRelationship(String serverName, String userId, String guid)`	Get a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`getUsedInContextRelationship(String serverName, String userId, String guid)`	Get a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.
`SubjectAreaOMASAPIResponse<ValidValue>`	`getValidValueRelationship(String serverName, String userId, String guid)`	Get a validValue relationship, which is a link between glossary terms that have the same meaning.
`SubjectAreaOMASAPIResponse<Antonym>`	`restoreAntonym(String serverName, String userId, String guid)`	Restore a Antonym
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`restoreCategoryAnchorRelationship(String serverName, String userId, String guid)`	Restore a CategoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`restoreCategoryHierarchyLink(String serverName, String userId, String guid)`	Restore a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`restoreIsaRelationship(String serverName, String userId, String guid)`	Restore a Isa Relationship
`SubjectAreaOMASAPIResponse<IsATypeOf>`	`restoreIsATypeOf(String serverName, String userId, String guid)`	Restore a 'IsATypeOf' Relationship
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`restorePreferredTerm(String serverName, String userId, String guid)`	Restore a PreferredTerm
`SubjectAreaOMASAPIResponse<ProjectScope>`	`restoreProjectScopeRelationship(String serverName, String userId, String guid)`	Restore a ProjectScope, which is a link between the project content and the project.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`restoreRelatedTerm(String serverName, String userId, String guid)`	Restore a related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`restoreReplacementTerm(String serverName, String userId, String guid)`	Restore a ReplacementTerm
`SubjectAreaOMASAPIResponse<Synonym>`	`restoreSynonym(String serverName, String userId, String guid)`	Restore a Synonym
`SubjectAreaOMASAPIResponse<TermAnchor>`	`restoreTermAnchorRelationship(String serverName, String userId, String guid)`	Restore a TermAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`restoreTermCategorizationRelationship(String serverName, String userId, String guid)`	Restore a TermCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`restoreTermHasARelationship(String serverName, String userId, String guid)`	Restore a has a relationship.
`SubjectAreaOMASAPIResponse<IsATypeOfDeprecated>`	`restoreTermIsATypeOfDeprecated(String serverName, String userId, String guid)`	Deprecated. IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
`SubjectAreaOMASAPIResponse<TypedBy>`	`restoreTermTYPEDBYRelationship(String serverName, String userId, String guid)`	Restore a Term TYPED BY relationship
`SubjectAreaOMASAPIResponse<Translation>`	`restoreTranslation(String serverName, String userId, String guid)`	Restore a Translation
`SubjectAreaOMASAPIResponse<UsedInContext>`	`restoreUsedInContext(String serverName, String userId, String guid)`	Restore a UsedInContext
`SubjectAreaOMASAPIResponse<ValidValue>`	`restoreValidValue(String serverName, String userId, String guid)`	Restore a ValidValue
`SubjectAreaOMASAPIResponse<Antonym>`	`updateAntonymRelationship(String serverName, String userId, String guid, Antonym antonym, Boolean isReplace)`	Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`SubjectAreaOMASAPIResponse<CategoryAnchor>`	`updateCategoryAnchorRelationship(String serverName, String userId, String guid, CategoryAnchor categoryAnchor, Boolean isReplace)`	Update a categoryAnchor Relationship.
`SubjectAreaOMASAPIResponse<CategoryHierarchyLink>`	`updateCategoryHierarchyLink(String serverName, String userId, String guid, CategoryHierarchyLink categoryHierarchyLink, Boolean isReplace)`	Update a CategoryHierarchyLink Relationship.
`SubjectAreaOMASAPIResponse<IsA>`	`updateIsARelationship(String serverName, String userId, String guid, IsA isa, Boolean isReplace)`	Update a IsARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`SubjectAreaOMASAPIResponse<IsATypeOfDeprecated>`	`updateIsARelationship(String serverName, String userId, String guid, IsATypeOfDeprecated isatypeof, Boolean isReplace)`	Deprecated. IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
`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.
`SubjectAreaOMASAPIResponse<PreferredTerm>`	`updatePreferredTermRelationship(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.
`SubjectAreaOMASAPIResponse<ProjectScope>`	`updateProjectScopeRelationship(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.
`SubjectAreaOMASAPIResponse<RelatedTerm>`	`updateRelatedTerm(String serverName, String userId, String guid, RelatedTerm relatedTermRelationship, Boolean isReplace)`	Update a Related Term relationship.
`SubjectAreaOMASAPIResponse<ReplacementTerm>`	`updateReplacementTermRelationship(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.
`SubjectAreaOMASAPIResponse<Synonym>`	`updateSynonymRelationship(String serverName, String userId, String guid, Synonym synonym, Boolean isReplace)`	Update a Synonym relationship which is a link between glossary terms that have the same meaning
`SubjectAreaOMASAPIResponse<TermAnchor>`	`updateTermAnchorRelationship(String serverName, String userId, String guid, TermAnchor termAnchor, Boolean isReplace)`	Update a termAnchor Relationship.
`SubjectAreaOMASAPIResponse<Categorization>`	`updateTermCategorizationRelationship(String serverName, String userId, String guid, Categorization categorization, Boolean isReplace)`	Update a termCategorization Relationship.
`SubjectAreaOMASAPIResponse<HasA>`	`updateTermHasARelationship(String serverName, String userId, String guid, HasA termHasARelationship, Boolean isReplace)`	Update a TermHasARelationship is the relationship between a spine object and a spine attribute.
`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.
`SubjectAreaOMASAPIResponse<Translation>`	`updateTranslationRelationship(String serverName, String userId, String guid, Translation translation, Boolean isReplace)`	Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`SubjectAreaOMASAPIResponse<UsedInContext>`	`updateUsedInContextRelationship(String serverName, String userId, String guid, UsedInContext 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<ValidValue>`	`updateValidValueRelationship(String serverName, String userId, String guid, ValidValue validValue, Boolean isReplace)`	Update a ValidValue relationship which is a link between glossary terms that have the same meaning

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

Constructor Detail
- GlossaryAuthorViewRelationshipRESTResource
```
public GlossaryAuthorViewRelationshipRESTResource()
```
  Default constructor

Method Detail

createTermHasARelationship
```
@PostMapping(path="/has-as")
public SubjectAreaOMASAPIResponse<HasA> createTermHasARelationship(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @RequestBody
                                                                   HasA 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.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

getTermHasARelationship

@GetMapping(path="/has-as/{guid}")
public SubjectAreaOMASAPIResponse<HasA> getTermHasARelationship(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                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.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateTermHasARelationship

@PutMapping(path="/has-as/{guid}")
public SubjectAreaOMASAPIResponse<HasA> updateTermHasARelationship(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @PathVariable
                                                                   String guid,
                                                                   @RequestBody
                                                                   HasA termHasARelationship,
                                                                   @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                   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

guid - unique identifier of the Relationship

termHasARelationship - the HasA relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created TermHasARelationship 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

@DeleteMapping(path="/has-as/{guid}")
public SubjectAreaOMASAPIResponse<HasA> deleteTermHasARelationship(@PathVariable
                                                                   String serverName,
                                                                   @PathVariable
                                                                   String userId,
                                                                   @PathVariable
                                                                   String guid,
                                                                   @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                   Boolean isPurge)

Delete a Term HAS A relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the HAS A relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/has-as/{guid}")
public SubjectAreaOMASAPIResponse<HasA> restoreTermHasARelationship(@PathVariable
                                                                    String serverName,
                                                                    @PathVariable
                                                                    String userId,
                                                                    @PathVariable
                                                                    String guid)
```
Restore a 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
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

createRelatedTerm

@PostMapping(path="/related-terms")
public SubjectAreaOMASAPIResponse<RelatedTerm> createRelatedTerm(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @RequestBody
                                                                 RelatedTerm relatedTermRelationship)

Create a RelatedTerm. A Related Term is a link between two similar Terms.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

relatedTermRelationship - the RelatedTerm relationship

Returns:

response, when successful contains the created Related Term 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.

getRelatedTerm
```
@GetMapping(path="/related-terms/{guid}")
public SubjectAreaOMASAPIResponse<RelatedTerm> getRelatedTerm(@PathVariable
                                                              String serverName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              String guid)
```
Get a related Term relationship.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the related term relationship to get

Returns:
response which when successful contains the related term relationship with the requested guid when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

updateRelatedTerm

@PutMapping(path="/related-terms/{guid}")
public SubjectAreaOMASAPIResponse<RelatedTerm> updateRelatedTerm(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String guid,
                                                                 @RequestBody
                                                                 RelatedTerm relatedTermRelationship,
                                                                 @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                 Boolean isReplace)

Update a Related Term relationship. A Related Term is a link between two similar Terms.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

relatedTermRelationship - the related term relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the 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.

deleteRelatedTerm

@DeleteMapping(path="/related-terms/{guid}")
public SubjectAreaOMASAPIResponse<RelatedTerm> deleteRelatedTerm(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String guid,
                                                                 @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                 Boolean isPurge)

Delete a Related Term relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Related term relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/related-terms/{guid}")
public SubjectAreaOMASAPIResponse<RelatedTerm> restoreRelatedTerm(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String guid)
```
Restore a related Term relationship.
Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the relationship to restore

Returns:
response which when successful contains the restored relationship when not successful the following Exception responses can occur
- 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
```
@PostMapping(path="/synonyms")
public SubjectAreaOMASAPIResponse<Synonym> createSynonym(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @RequestBody
                                                         Synonym synonym)
```
Create a synonym relationship, which is a link between glossary terms that have the same meaning.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

synonym - the Synonym relationship

Returns:
response, when successful contains the created synonym relationship when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

getSynonymRelationship
```
@GetMapping(path="/synonyms/{guid}")
public SubjectAreaOMASAPIResponse<Synonym> getSynonymRelationship(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  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 synonym 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.

updateSynonymRelationship

@PutMapping(path="/synonyms/{guid}")
public SubjectAreaOMASAPIResponse<Synonym> updateSynonymRelationship(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String guid,
                                                                     @RequestBody
                                                                     Synonym synonym,
                                                                     @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                     Boolean isReplace)

Update a Synonym relationship which is a link between glossary terms that have the same meaning

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

synonym - the synonym relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created SynonymRelationship 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.

deleteSynonymRelationship

@DeleteMapping(path="/synonyms/{guid}")
public SubjectAreaOMASAPIResponse<Synonym> deleteSynonymRelationship(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String guid,
                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                     Boolean isPurge)

Delete a Synonym relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Synonym relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/synonyms/{guid}")
public SubjectAreaOMASAPIResponse<Synonym> restoreSynonym(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String guid)
```
Restore a Synonym
Restore allows the deleted Synonym 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 Synonym to delete

Returns:
response which when successful contains the restored 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.

createAntonym
```
@PostMapping(path="/antonyms")
public SubjectAreaOMASAPIResponse<Antonym> createAntonym(@PathVariable
                                                         String serverName,
                                                         @PathVariable
                                                         String userId,
                                                         @RequestBody
                                                         Antonym antonym)
```
Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

antonym - the Antonym relationship

Returns:
response, when successful contains the created antonym relationship when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

getAntonymRelationship

@GetMapping(path="/antonyms/{guid}")
public SubjectAreaOMASAPIResponse<Antonym> getAntonymRelationship(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String guid)

Get a antonym relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the related term relationship to get

Returns:

response which when successful contains the antonym relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateAntonymRelationship

@PutMapping(path="/antonyms/{guid}")
public SubjectAreaOMASAPIResponse<Antonym> updateAntonymRelationship(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String guid,
                                                                     @RequestBody
                                                                     Antonym antonym,
                                                                     @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                     Boolean isReplace)

Update a Antonym relationship which is a link between glossary terms that have the opposite meaning

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

antonym - the antonym relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created AntonymRelationship 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.

deleteAntonymRelationship

@DeleteMapping(path="/antonyms/{guid}")
public SubjectAreaOMASAPIResponse<Antonym> deleteAntonymRelationship(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String guid,
                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                     Boolean isPurge)

Delete a Antonym relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Antonym relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/antonyms/{guid}")
public SubjectAreaOMASAPIResponse<Antonym> restoreAntonym(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String guid)
```
Restore a Antonym
Restore allows the deleted Antonym 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 Antonym to delete

Returns:
response which when successful contains the restored 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.

createTranslation
```
@PostMapping(path="/translations")
public SubjectAreaOMASAPIResponse<Translation> createTranslation(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @RequestBody
                                                                 Translation translation)
```
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

translation - the Translation relationship

Returns:
response, when successful contains the created translation 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.

getTranslationRelationship
```
@GetMapping(path="/translations/{guid}")
public SubjectAreaOMASAPIResponse<Translation> getTranslationRelationship(@PathVariable
                                                                          String serverName,
                                                                          @PathVariable
                                                                          String userId,
                                                                          @PathVariable
                                                                          String guid)
```
Get a translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the translation relationship to get

Returns:
response which when successful contains the translation relationship with the requested guid when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

updateTranslationRelationship

@PutMapping(path="/translations/{guid}")
public SubjectAreaOMASAPIResponse<Translation> updateTranslationRelationship(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String guid,
                                                                             @RequestBody
                                                                             Translation translation,
                                                                             @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                             Boolean isReplace)

Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

translation - the translation relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created TranslationRelationship 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.

deleteTranslationRelationship

@DeleteMapping(path="/translations/{guid}")
public SubjectAreaOMASAPIResponse<Translation> deleteTranslationRelationship(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String guid,
                                                                             @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                             Boolean isPurge)

Delete a Translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Translation relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreTranslation
```
@PostMapping(path="/translations/{guid}")
public SubjectAreaOMASAPIResponse<Translation> restoreTranslation(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String guid)
```
Restore a Translation
Restore allows the deleted Translation 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 Translation to delete

Returns:
response which when successful contains the restored Translation 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

@PostMapping(path="/used-in-contexts")
public SubjectAreaOMASAPIResponse<UsedInContext> createusedInContext(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @RequestBody
                                                                     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 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.

getUsedInContextRelationship

@GetMapping(path="/used-in-contexts/{guid}")
public SubjectAreaOMASAPIResponse<UsedInContext> getUsedInContextRelationship(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @PathVariable
                                                                              String guid)

Get a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the usedInContext relationship to get

Returns:

response which when successful contains the usedInContext relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateUsedInContextRelationship

@PutMapping(path="/used-in-contexts/{guid}")
public SubjectAreaOMASAPIResponse<UsedInContext> updateUsedInContextRelationship(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String guid,
                                                                                 @RequestBody
                                                                                 UsedInContext usedInContext,
                                                                                 @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                 Boolean isReplace)

Update a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

usedInContext - the used in context 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 created UsedInContextRelationship 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.

deleteUsedInContextRelationship

@DeleteMapping(path="/used-in-contexts/{guid}")
public SubjectAreaOMASAPIResponse<UsedInContext> deleteUsedInContextRelationship(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String guid,
                                                                                 @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                 Boolean isPurge)

Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the UsedInContext relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/used-in-contexts/{guid}")
public SubjectAreaOMASAPIResponse<UsedInContext> restoreUsedInContext(@PathVariable
                                                                      String serverName,
                                                                      @PathVariable
                                                                      String userId,
                                                                      @PathVariable
                                                                      String guid)
```
Restore a UsedInContext
Restore allows the deleted UsedInContext 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 UsedInContext to delete

Returns:
response which when successful contains the restored 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.

createPreferredTerm

@PostMapping(path="/preferred-terms")
public SubjectAreaOMASAPIResponse<PreferredTerm> createPreferredTerm(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @RequestBody
                                                                     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 preferred term relationship

Returns:

response, when successful contains the created preferredTerm 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.

getPreferredTermRelationship

@GetMapping(path="/preferred-terms/{guid}")
public SubjectAreaOMASAPIResponse<PreferredTerm> getPreferredTermRelationship(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @PathVariable
                                                                              String guid)

Get a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the preferredTerm relationship to get

Returns:

response which when successful contains the preferredTerm relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updatePreferredTermRelationship

@PutMapping(path="/preferred-terms/{guid}")
public SubjectAreaOMASAPIResponse<PreferredTerm> updatePreferredTermRelationship(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String guid,
                                                                                 @RequestBody
                                                                                 PreferredTerm preferredTerm,
                                                                                 @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                 Boolean isReplace)

Update a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

preferredTerm - the preferred term relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created PreferredTermRelationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised
ClassificationException Error processing a classification
FunctionNotSupportedException Function not supported
StatusNotSupportedException A status value is not supported

deletePreferredTermRelationship

@DeleteMapping(path="/preferred-terms/{guid}")
public SubjectAreaOMASAPIResponse<PreferredTerm> deletePreferredTermRelationship(@PathVariable
                                                                                 String serverName,
                                                                                 @PathVariable
                                                                                 String userId,
                                                                                 @PathVariable
                                                                                 String guid,
                                                                                 @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                 Boolean isPurge)

Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the PreferredTerm relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/preferred-terms/{guid}")
public SubjectAreaOMASAPIResponse<PreferredTerm> restorePreferredTerm(@PathVariable
                                                                      String serverName,
                                                                      @PathVariable
                                                                      String userId,
                                                                      @PathVariable
                                                                      String guid)
```
Restore a PreferredTerm
Restore allows the deleted PreferredTerm 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 PreferredTerm to delete

Returns:
response which when successful contains the restored 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.

createValidValue

@PostMapping(path="/valid-values")
public SubjectAreaOMASAPIResponse<ValidValue> createValidValue(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestBody
                                                               ValidValue validValue)

Create a validValue relationship, which is a link between glossary terms that have the same meaning.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

validValue - the ValidValue relationship

Returns:

response, when successful contains the created validValue 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.

getValidValueRelationship

@GetMapping(path="/valid-values/{guid}")
public SubjectAreaOMASAPIResponse<ValidValue> getValidValueRelationship(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        String guid)

Get a validValue relationship, which is a link between glossary terms that have the same meaning.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the validValue relationship to get

Returns:

response which when successful contains the validValue relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateValidValueRelationship

@PutMapping(path="/valid-values/{guid}")
public SubjectAreaOMASAPIResponse<ValidValue> updateValidValueRelationship(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String guid,
                                                                           @RequestBody
                                                                           ValidValue validValue,
                                                                           @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                           Boolean isReplace)

Update a ValidValue relationship which is a link between glossary terms that have the same meaning

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

validValue - the valid value 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 created ValidValueRelationship 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.

deleteValidValueRelationship

@DeleteMapping(path="/valid-values/{guid}")
public SubjectAreaOMASAPIResponse<ValidValue> deleteValidValueRelationship(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String guid,
                                                                           @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                           Boolean isPurge)

Delete a ValidValue relationship

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the ValidValue relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/valid-values/{guid}")
public SubjectAreaOMASAPIResponse<ValidValue> restoreValidValue(@PathVariable
                                                                String serverName,
                                                                @PathVariable
                                                                String userId,
                                                                @PathVariable
                                                                String guid)
```
Restore a ValidValue
Restore allows the deleted ValidValue 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 ValidValue to delete

Returns:
response which when successful contains the restored 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.

createReplacementTerm

@PostMapping(path="/replacement-terms")
public SubjectAreaOMASAPIResponse<ReplacementTerm> createReplacementTerm(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @RequestBody
                                                                         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 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.

getReplacementTermRelationship

@GetMapping(path="/replacement-terms/{guid}")
public SubjectAreaOMASAPIResponse<ReplacementTerm> getReplacementTermRelationship(@PathVariable
                                                                                  String serverName,
                                                                                  @PathVariable
                                                                                  String userId,
                                                                                  @PathVariable
                                                                                  String guid)

Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the replacementTerm relationship to get

Returns:

response which when successful contains the replacementTerm relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateReplacementTermRelationship

@PutMapping(path="/replacement-terms/{guid}")
public SubjectAreaOMASAPIResponse<ReplacementTerm> updateReplacementTermRelationship(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @PathVariable
                                                                                     String guid,
                                                                                     @RequestBody
                                                                                     ReplacementTerm replacementTerm,
                                                                                     @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                     Boolean isReplace)

Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

replacementTerm - the replacement term relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created ReplacementTermRelationship 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.

deleteReplacementTermRelationship

@DeleteMapping(path="/replacement-terms/{guid}")
public SubjectAreaOMASAPIResponse<ReplacementTerm> deleteReplacementTermRelationship(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @PathVariable
                                                                                     String guid,
                                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                     Boolean isPurge)

Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the ReplacementTerm relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

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
```
@PostMapping(path="/replacement-terms/{guid}")
public SubjectAreaOMASAPIResponse<ReplacementTerm> restoreReplacementTerm(@PathVariable
                                                                          String serverName,
                                                                          @PathVariable
                                                                          String userId,
                                                                          @PathVariable
                                                                          String guid)
```
Restore a ReplacementTerm
Restore allows the deleted ReplacementTerm 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 ReplacementTerm to delete

Returns:
response which when successful contains the restored 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.

createtermTYPEDBYRelationship

@PostMapping(path="/typed-bys")
public SubjectAreaOMASAPIResponse<TypedBy> createtermTYPEDBYRelationship(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @RequestBody
                                                                         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 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.

getTYPEDBYRelationship
```
@GetMapping(path="/typed-bys/{guid}")
public SubjectAreaOMASAPIResponse<TypedBy> getTYPEDBYRelationship(@PathVariable
                                                                  String serverName,
                                                                  @PathVariable
                                                                  String userId,
                                                                  @PathVariable
                                                                  String guid)
```
Get a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the termTYPEDBYRelationship relationship to get

Returns:
response which when successful contains the termTYPEDBYRelationship relationship with the requested guid when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

updateTermTYPEDBYRelationship

@PutMapping(path="/typed-bys/{guid}")
public SubjectAreaOMASAPIResponse<TypedBy> updateTermTYPEDBYRelationship(@PathVariable
                                                                         String serverName,
                                                                         @PathVariable
                                                                         String userId,
                                                                         @PathVariable
                                                                         String guid,
                                                                         @RequestBody
                                                                         TypedBy termTYPEDBYRelationship,
                                                                         @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                         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 - unique identifier of the Relationship

termTYPEDBYRelationship - the typed by 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 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.

deleteTypedByRelationship

@DeleteMapping(path="/typed-bys/{guid}")
public SubjectAreaOMASAPIResponse<TypedBy> deleteTypedByRelationship(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @PathVariable
                                                                     String guid,
                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                     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 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.

restoreTermTYPEDBYRelationship
```
@PostMapping(path="/typed-bys/{guid}")
public SubjectAreaOMASAPIResponse<TypedBy> restoreTermTYPEDBYRelationship(@PathVariable
                                                                          String serverName,
                                                                          @PathVariable
                                                                          String userId,
                                                                          @PathVariable
                                                                          String guid)
```
Restore a Term TYPED BY relationship
Restore allows the deleted TermTYPEDBY 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 TermTYPEDBY to delete

Returns:
response which when successful contains the restored TermTYPEDBY 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
```
@PostMapping(path="/is-as")
public SubjectAreaOMASAPIResponse<IsA> createiSARelationship(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @RequestBody
                                                             IsA iSARelationship)
```
Create a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

iSARelationship - the IsARelationship relationship

Returns:
response, when successful contains the created iSARelationship relationship when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

getIsARelationship
```
@GetMapping(path="/is-as/{guid}")
public SubjectAreaOMASAPIResponse<IsA> getIsARelationship(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          String guid)
```
Get a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the iSARelationship relationship to get

Returns:
response which when successful contains the iSARelationship relationship with the requested guid when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

updateIsARelationship

@PutMapping(path="/is-as/{guid}")
public SubjectAreaOMASAPIResponse<IsA> updateIsARelationship(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String guid,
                                                             @RequestBody
                                                             IsA isa,
                                                             @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                             Boolean isReplace)

Update a IsARelationship relationship, which is a link between a more general glossary term and a more specific definition.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

isa - the is-a 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 created IsARelationship 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.

deleteTermIsARelationship

@DeleteMapping(path="/is-as/{guid}")
public SubjectAreaOMASAPIResponse<IsA> deleteTermIsARelationship(@PathVariable
                                                                 String serverName,
                                                                 @PathVariable
                                                                 String userId,
                                                                 @PathVariable
                                                                 String guid,
                                                                 @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                 Boolean isPurge)

Delete a IsARelationship relationship, which is a link between a more general glossary term and a more specific definition.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the IsARelationship relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreIsaRelationship
```
@PostMapping(path="/is-as/{guid}")
public SubjectAreaOMASAPIResponse<IsA> restoreIsaRelationship(@PathVariable
                                                              String serverName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              String guid)
```
Restore a Isa Relationship
Restore allows the deleted Isa 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 Isa Relationship to delete

Returns:
response which when successful contains the restored IsaRelationship 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

@PostMapping(path="/is-a-type-of-deprecateds")
public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> createTermIsATypeOfDeprecated(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @RequestBody
                                                                                     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 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.

getTermIsATypeOfDeprecated
```
@GetMapping(path="/is-a-type-of-deprecateds/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> getTermIsATypeOfDeprecated(@PathVariable
                                                                                  String serverName,
                                                                                  @PathVariable
                                                                                  String userId,
                                                                                  @PathVariable
                                                                                  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 TermIsATypeOfDeprecated relationship to get

Returns:
response which when successful contains the TermIsATypeOfDeprecated 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

@PutMapping(path="/is-a-type-of-deprecateds/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> updateIsARelationship(@PathVariable
                                                                             String serverName,
                                                                             @PathVariable
                                                                             String userId,
                                                                             @PathVariable
                                                                             String guid,
                                                                             @RequestBody
                                                                             IsATypeOfDeprecated isatypeof,
                                                                             @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                             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 - unique identifier of the relationship

isatypeof - the is-a-type-of 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 created IsARelationship 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

@DeleteMapping(path="/is-a-type-of-deprecateds/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> deleteTermIsATypeOfDeprecated(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @PathVariable
                                                                                     String guid,
                                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                     Boolean isPurge)

Deprecated.

IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.

Delete a TermIsATypeOf Relationship 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 TermIsATypeOfDeprecated relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreTermIsATypeOfDeprecated
```
@PostMapping(path="/is-a-type-of-deprecateds/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> restoreTermIsATypeOfDeprecated(@PathVariable
                                                                                      String serverName,
                                                                                      @PathVariable
                                                                                      String userId,
                                                                                      @PathVariable
                                                                                      String guid)
```
Deprecated.
IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.
Restore allows the deleted Is a Type Of Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.

Restore a TermIsATypeOf Relationship 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 Term Is a Type Of Relationship to delete

Returns:
response which when successful contains the restored 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.

createIsATypeOf
```
@PostMapping(path="/is-a-type-ofs")
public SubjectAreaOMASAPIResponse<IsATypeOf> createIsATypeOf(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @RequestBody
                                                             IsATypeOf IsATypeOf)
```
Create a IsATypeOf Relationship 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 relationship when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- MetadataServerUncontactableException not able to communicate with a Metadata respository service.
- InvalidParameterException one of the parameters is null or invalid.
- UnrecognizedGUIDException the supplied guid was not recognised
- ClassificationException Error processing a classification.
- StatusNotSupportedException A status value is not supported.
- FunctionNotSupportedException Function not supported.

getIsATypeOf
```
@GetMapping(path="/is-a-type-ofs/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOf> getIsATypeOf(@PathVariable
                                                          String serverName,
                                                          @PathVariable
                                                          String userId,
                                                          @PathVariable
                                                          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 IsATypeOf 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

@PutMapping(path="/is-a-type-ofs/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOf> updateIsATypeOf(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String guid,
                                                             @RequestBody
                                                             IsATypeOf IsATypeOf,
                                                             @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                             Boolean isReplace)

Update a IsATypeOf Relationship, which is an inheritance relationship between two spine objects.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the relationship

IsATypeOf - the IsATypeOfs 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 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.

deleteIsATypeOf

@DeleteMapping(path="/is-a-type-ofs/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOf> deleteIsATypeOf(@PathVariable
                                                             String serverName,
                                                             @PathVariable
                                                             String userId,
                                                             @PathVariable
                                                             String guid,
                                                             @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                             Boolean isPurge)

Delete a IsATypeOf, 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 relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreIsATypeOf
```
@PostMapping(path="/is-a-type-ofs/{guid}")
public SubjectAreaOMASAPIResponse<IsATypeOf> restoreIsATypeOf(@PathVariable
                                                              String serverName,
                                                              @PathVariable
                                                              String userId,
                                                              @PathVariable
                                                              String guid)
```
Restore a 'IsATypeOf' Relationship
Restore allows the deleted 'IsATypeOf' Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Term 'IsATypeOf' Relationship to delete

Returns:
response which when successful contains the restoredIsATypeOf 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

@PostMapping(path="/term-categorizations")
public SubjectAreaOMASAPIResponse<Categorization> createTermCategorization(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @RequestBody
                                                                           Categorization termCategorizationRelationship)

Create a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

termCategorizationRelationship - the TermCategorization Relationship

Returns:

response, when successful contains the created termCategorization 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.

getTermCategorizationRelationship

@GetMapping(path="/term-categorizations/{guid}")
public SubjectAreaOMASAPIResponse<Categorization> getTermCategorizationRelationship(@PathVariable
                                                                                    String serverName,
                                                                                    @PathVariable
                                                                                    String userId,
                                                                                    @PathVariable
                                                                                    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 termCategorization Relationship with the requested guid when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateTermCategorizationRelationship

@PutMapping(path="/term-categorizations/{guid}")
public SubjectAreaOMASAPIResponse<Categorization> updateTermCategorizationRelationship(@PathVariable
                                                                                       String serverName,
                                                                                       @PathVariable
                                                                                       String userId,
                                                                                       @PathVariable
                                                                                       String guid,
                                                                                       @RequestBody
                                                                                       Categorization categorization,
                                                                                       @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                       Boolean isReplace)

Update a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - unique identifier of the Relationship

categorization - the categorization 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 created termCategorization 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.

deleteTermCategorizationRelationship

@DeleteMapping(path="/term-categorizations/{guid}")
public SubjectAreaOMASAPIResponse<Categorization> deleteTermCategorizationRelationship(@PathVariable
                                                                                       String serverName,
                                                                                       @PathVariable
                                                                                       String userId,
                                                                                       @PathVariable
                                                                                       String guid,
                                                                                       @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                       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 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.

restoreTermCategorizationRelationship
```
@PostMapping(path="/term-categorizations/{guid}")
public SubjectAreaOMASAPIResponse<Categorization> restoreTermCategorizationRelationship(@PathVariable
                                                                                        String serverName,
                                                                                        @PathVariable
                                                                                        String userId,
                                                                                        @PathVariable
                                                                                        String guid)
```
Restore a TermCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.
Restore allows the deleted TermCategorization Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Term Is a Type Of Relationship to delete

Returns:
response which when successful contains the restored 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.

createTermAnchor
```
@PostMapping(path="/term-anchors")
public SubjectAreaOMASAPIResponse<TermAnchor> createTermAnchor(@PathVariable
                                                               String serverName,
                                                               @PathVariable
                                                               String userId,
                                                               @RequestBody
                                                               TermAnchor termAnchorRelationship)
```
Create a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary. Terms created using the Subject Area OMAS cannot be created without a glossary and there can only be one glossary associated with a Term. This method is to allow glossaries to be associated with Terms that have not been created via the Subject Area OMAS or to recreate the TermAnchor relationship if it has been purged.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

termAnchorRelationship - the TermAnchor Relationship

Returns:
response, when successful contains the created termAnchor 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.

getTermAnchorRelationship
```
@GetMapping(path="/term-anchors/{guid}")
public SubjectAreaOMASAPIResponse<TermAnchor> getTermAnchorRelationship(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @PathVariable
                                                                        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 termAnchor 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.

updateTermAnchorRelationship

@PutMapping(path="/term-anchors/{guid}")
public SubjectAreaOMASAPIResponse<TermAnchor> updateTermAnchorRelationship(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String guid,
                                                                           @RequestBody
                                                                           TermAnchor termAnchor,
                                                                           @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                           Boolean isReplace)

Update a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - guid of the TermAnchor relationship

termAnchor - the termAnchor relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the updated termAnchor when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

deleteTermAnchorRelationship

@DeleteMapping(path="/term-anchors/{guid}")
public SubjectAreaOMASAPIResponse<TermAnchor> deleteTermAnchorRelationship(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @PathVariable
                                                                           String guid,
                                                                           @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                           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 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.

restoreTermAnchorRelationship
```
@PostMapping(path="/term-anchors/{guid}")
public SubjectAreaOMASAPIResponse<TermAnchor> restoreTermAnchorRelationship(@PathVariable
                                                                            String serverName,
                                                                            @PathVariable
                                                                            String userId,
                                                                            @PathVariable
                                                                            String guid)
```
Restore a TermAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.
Restore allows the deleted TermAnchor Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Term Anchor Relationship to delete

Returns:
response which when successful contains the restored TermAnchor when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

createCategoryAnchor
```
@PostMapping(path="/category-anchors")
public SubjectAreaOMASAPIResponse<CategoryAnchor> createCategoryAnchor(@PathVariable
                                                                       String serverName,
                                                                       @PathVariable
                                                                       String userId,
                                                                       @RequestBody
                                                                       CategoryAnchor categoryAnchorRelationship)
```
Create a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary. Categories created using the Subject Area OMAS cannot be created without a glossary and there can only be one glossary associated with a Category. This method is to allow glossaries to be associated with Categories that have not been created via the Subject Area OMAS or to recreate the CategoryAnchor 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

categoryAnchorRelationship - the CategoryAnchor Relationship

Returns:
response, when successful contains the created categoryAnchor 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.

getCategoryAnchorRelationship

@GetMapping(path="/category-anchors/{guid}")
public SubjectAreaOMASAPIResponse<CategoryAnchor> getCategoryAnchorRelationship(@PathVariable
                                                                                String serverName,
                                                                                @PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String guid)

Get a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the categoryAnchor Relationship to get

Returns:

response which when successful contains the categoryAnchor 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.

deleteCategoryAnchorRelationship

@DeleteMapping(path="/category-anchors/{guid}")
public SubjectAreaOMASAPIResponse<CategoryAnchor> deleteCategoryAnchorRelationship(@PathVariable
                                                                                   String serverName,
                                                                                   @PathVariable
                                                                                   String userId,
                                                                                   @PathVariable
                                                                                   String guid,
                                                                                   @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                   Boolean isPurge)

Delete a CategoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the CategoryAnchor Relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

updateCategoryAnchorRelationship

@PutMapping(path="/category-anchors/{guid}")
public SubjectAreaOMASAPIResponse<CategoryAnchor> updateCategoryAnchorRelationship(@PathVariable
                                                                                   String serverName,
                                                                                   @PathVariable
                                                                                   String userId,
                                                                                   @PathVariable
                                                                                   String guid,
                                                                                   @RequestBody
                                                                                   CategoryAnchor categoryAnchor,
                                                                                   @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                   Boolean isReplace)

Update a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows Categories to be owned by a Glossary.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - userId under which the request is performed

guid - guid of the CategoryAnchor relationship

categoryAnchor - the categoryAnchor relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the updated categoryAnchor when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreCategoryAnchorRelationship
```
@PostMapping(path="/category-anchors/{guid}")
public SubjectAreaOMASAPIResponse<CategoryAnchor> restoreCategoryAnchorRelationship(@PathVariable
                                                                                    String serverName,
                                                                                    @PathVariable
                                                                                    String userId,
                                                                                    @PathVariable
                                                                                    String guid)
```
Restore a CategoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.
Restore allows the deleted CategoryAnchor Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the Category Anchor Relationship to delete

Returns:
response which when successful contains the restored CategoryAnchor when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.

createProjectScopeRelationship

@PostMapping(path="/project-scopes")
public SubjectAreaOMASAPIResponse<ProjectScope> createProjectScopeRelationship(@PathVariable
                                                                               String serverName,
                                                                               @PathVariable
                                                                               String userId,
                                                                               @RequestBody
                                                                               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 Project scope relationship

Returns:

response, when successful contains the created project scope 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.

getProjectScopeRelationship

@GetMapping(path="/project-scopes/{guid}")
public SubjectAreaOMASAPIResponse<ProjectScope> getProjectScopeRelationship(@PathVariable
                                                                            String serverName,
                                                                            @PathVariable
                                                                            String userId,
                                                                            @PathVariable
                                                                            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 project scope relationship to get

Returns:

response which when successful contains the project scope 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.

updateProjectScopeRelationship

@PutMapping(path="/project-scopes/{guid}")
public SubjectAreaOMASAPIResponse<ProjectScope> updateProjectScopeRelationship(@PathVariable
                                                                               String serverName,
                                                                               @PathVariable
                                                                               String userId,
                                                                               @PathVariable
                                                                               String guid,
                                                                               @RequestBody
                                                                               ProjectScope projectScope,
                                                                               @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                               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 - unique identifier of the Relationship

projectScope - the projectScope relationship

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.

Returns:

response, when successful contains the created ProjectScopeRelationship 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.

deleteProjectScopeRelationship

@DeleteMapping(path="/project-scopes/{guid}")
public SubjectAreaOMASAPIResponse<ProjectScope> deleteProjectScopeRelationship(@PathVariable
                                                                               String serverName,
                                                                               @PathVariable
                                                                               String userId,
                                                                               @PathVariable
                                                                               String guid,
                                                                               @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                               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 Project scope relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreProjectScopeRelationship
```
@PostMapping(path="/project-scopes/{guid}")
public SubjectAreaOMASAPIResponse<ProjectScope> restoreProjectScopeRelationship(@PathVariable
                                                                                String serverName,
                                                                                @PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String guid)
```
Restore a ProjectScope, which is a link between the project content and the project.
Restore allows the deleted ProjectScopeRelationship 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 ProjectScopeRelationship to delete

Returns:
response which when successful contains the restored ProjectScopeRelationship 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

@GetMapping(path="/semantic-assignments/{guid}")
public SubjectAreaOMASAPIResponse<SemanticAssignment> getSemanticAssignmentRelationship(@PathVariable
                                                                                        String serverName,
                                                                                        @PathVariable
                                                                                        String userId,
                                                                                        @PathVariable
                                                                                        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.

createCategoryHierarchyLink

@PostMapping(path="/category-hierarchy-links")
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> createCategoryHierarchyLink(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @RequestBody
                                                                                     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

@GetMapping(path="/category-hierarchy-links/{guid}")
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> getCategoryHierarchyLink(@PathVariable
                                                                                  String serverName,
                                                                                  @PathVariable
                                                                                  String userId,
                                                                                  @PathVariable
                                                                                  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

@PutMapping(path="/category-hierarchy-links/{guid}")
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> updateCategoryHierarchyLink(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @PathVariable
                                                                                     String guid,
                                                                                     @RequestBody
                                                                                     CategoryHierarchyLink categoryHierarchyLink,
                                                                                     @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                     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

@DeleteMapping(path="/category-hierarchy-links/{guid}")
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> deleteCategoryHierarchyLink(@PathVariable
                                                                                     String serverName,
                                                                                     @PathVariable
                                                                                     String userId,
                                                                                     @PathVariable
                                                                                     String guid,
                                                                                     @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                     Boolean isPurge)

Delete a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.

Parameters:

serverName - serverName under which this request is performed, this is used in multi tenanting to identify the tenant

userId - unique identifier for requesting user, under which the request is performed

guid - guid of the CategoryHierarchyLink relationship to delete

isPurge - true indicates a hard delete, false is a soft delete.

Returns:

response for a soft delete the response contains the deleted relationship when not successful the following Exception responses can occur

UserNotAuthorizedException the requesting user is not authorized to issue this request.
InvalidParameterException one of the parameters is null or invalid.
PropertyServerException Property server exception.

restoreCategoryHierarchyLink
```
@PostMapping(path="/category-hierarchy-links/{guid}")
public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> restoreCategoryHierarchyLink(@PathVariable
                                                                                      String serverName,
                                                                                      @PathVariable
                                                                                      String userId,
                                                                                      @PathVariable
                                                                                      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.

Class GlossaryAuthorViewRelationshipRESTResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlossaryAuthorViewRelationshipRESTResource

Method Detail

createTermHasARelationship

getTermHasARelationship

updateTermHasARelationship

deleteTermHasARelationship

restoreTermHasARelationship

createRelatedTerm

getRelatedTerm

updateRelatedTerm

deleteRelatedTerm

restoreRelatedTerm

createSynonym

getSynonymRelationship

updateSynonymRelationship

deleteSynonymRelationship

restoreSynonym

createAntonym

getAntonymRelationship

updateAntonymRelationship

deleteAntonymRelationship

restoreAntonym

createTranslation

getTranslationRelationship

updateTranslationRelationship

deleteTranslationRelationship

restoreTranslation

createusedInContext

getUsedInContextRelationship

updateUsedInContextRelationship

deleteUsedInContextRelationship

restoreUsedInContext

createPreferredTerm

getPreferredTermRelationship

updatePreferredTermRelationship

deletePreferredTermRelationship

restorePreferredTerm

createValidValue

getValidValueRelationship

updateValidValueRelationship

deleteValidValueRelationship

restoreValidValue

createReplacementTerm

getReplacementTermRelationship

updateReplacementTermRelationship

deleteReplacementTermRelationship

restoreReplacementTerm

createtermTYPEDBYRelationship

getTYPEDBYRelationship

updateTermTYPEDBYRelationship

deleteTypedByRelationship

restoreTermTYPEDBYRelationship

createiSARelationship

getIsARelationship

updateIsARelationship

deleteTermIsARelationship

restoreIsaRelationship

createTermIsATypeOfDeprecated

getTermIsATypeOfDeprecated

updateIsARelationship

deleteTermIsATypeOfDeprecated

restoreTermIsATypeOfDeprecated

createIsATypeOf

getIsATypeOf

updateIsATypeOf

deleteIsATypeOf

restoreIsATypeOf

createTermCategorization

getTermCategorizationRelationship

updateTermCategorizationRelationship

deleteTermCategorizationRelationship

restoreTermCategorizationRelationship

createTermAnchor

getTermAnchorRelationship

updateTermAnchorRelationship