SubjectAreaRelationshipRESTResource (Subject Area OMAS with Spring 1.0 API)

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

```
@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/subject-area")
public class SubjectAreaRelationshipRESTResource
extends SubjectAreaRESTServicesInstance
```
The SubjectAreaRESTServicesInstance provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectAreaDefinition Open Metadata Assess Service (OMAS). This interface provides relationship authoring interfaces for subject area experts.

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

Constructor Summary

Constructors
Constructor and Description

SubjectAreaRelationshipRESTResource()
Default constructor

Constructors
Constructor and Description
`SubjectAreaRelationshipRESTResource()` Default constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createAntonym(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym)` Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createiSARelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ISARelationship iSARelationship)` Create a iSARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createpreferredTerm(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createRelatedTerm(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationshipRelationship)` Create a RelatedTerm.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createreplacementTerm(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm)` Create a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createSynonym(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym)` Create a synonym relationship, which is a link between glossary terms that have the same meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createTermCategorization(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermCategorizationRelationship termCategorizationRelationship)` Create a termCategorization Relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createTermHASARelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermHASARelationship termHASARelationship)` Create a TermHASARelationship is the relationship between a spine object and a spine attribute.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createtermISATypeOFRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermISATypeOFRelationship termISATypeOFRelationship)` Create a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createtermTYPEDBYRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermTYPEDBYRelationship termTYPEDBYRelationship)` Create a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createTranslation(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation)` Create a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createusedInContext(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`createvalidValue(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue)` Create a validValue relationship, which is a link between glossary terms that have the same meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteAntonymRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Antonym relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteRelatedTerm(String serverName, String userId, String guid, Boolean isPurge)` Delete a Related Term relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteSynonymRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Synonym relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteTermCategorizationRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TermCategorization Relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteTermHASARelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a Term HAS A relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteTermIsaTypeOfRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TermISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteTypedByRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a TermTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`deleteValidValueRelationship(String serverName, String userId, String guid, Boolean isPurge)` Delete a ValidValue relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getAntonymRelationship(String serverName, String userId, String guid)` Get a antonym relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getRelatedTerm(String serverName, String userId, String guid)` Get a related Term relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getSemanticAssignmentRelationship(String serverName, String userId, String guid)` Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getSynonymRelationship(String serverName, String userId, String guid)` Get a synonym relationship, which is a link between glossary terms that have the same meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getTermCategorizationRelationship(String serverName, String userId, String guid)` Get a termCategorization Relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getTermHASARelationship(String serverName, String userId, String guid)` Get a Term HAS A relationship
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getTermISATypeOFRelationship(String serverName, String userId, String guid)` Get a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getTYPEDBYRelationshipRelationship(String serverName, String userId, String guid)` Get a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`getValidValueRelationship(String serverName, String userId, String guid)` Get a validValue relationship, which is a link between glossary terms that have the same meaning.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreAntonym(String serverName, String userId, String guid)` Restore a Antonym Restore allows the deleted Antonym to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreIsaRelationship(String serverName, String userId, String guid)` Restore a Isa Relationship Restore allows the deleted Isa Relationship to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restorePreferredTerm(String serverName, String userId, String guid)` Restore a PreferredTerm Restore allows the deleted PreferredTerm to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreRelatedTerm(String serverName, String userId, String guid)` Restore a related Term relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreReplacementTerm(String serverName, String userId, String guid)` Restore a ReplacementTerm Restore allows the deleted ReplacementTerm to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreSynonym(String serverName, String userId, String guid)` Restore a Synonym Restore allows the deleted Synonym to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreTermCategorizationRelationship(String serverName, String userId, String guid)` Restore a TermCategorization Relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreTermHASARelationship(String serverName, String userId, String guid)` Restore a has a relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreTermIsaTypeOfRelationship(String serverName, String userId, String guid)` Restore a Is a Type Of Relationship Restore allows the deleted Is a Type Of Relationship to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreTermTYPEDBYRelationship(String serverName, String userId, String guid)` Restore a Term TYPED BY relationship Restore allows the deleted TermTYPEDBY to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreTranslation(String serverName, String userId, String guid)` Restore a Translation Restore allows the deleted Translation to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreUsedInContext(String serverName, String userId, String guid)` Restore a UsedInContext Restore allows the deleted UsedInContext to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`restoreValidValue(String serverName, String userId, String guid)` Restore a ValidValue Restore allows the deleted ValidValue to be made active again.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateAntonymRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym, Boolean isReplace)` Update a Antonym relationship which is a link between glossary terms that have the opposite meaning
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateISARelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ISARelationship isa, Boolean isReplace)` Update a ISARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateISARelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermISATypeOFRelationship isatypeof, Boolean isReplace)` Update a ISARelationship relationship, which is a link between a more general glossary term and a more specific definition.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updatePreferredTermRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateRelatedTerm(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationship, Boolean isReplace)` Update a Related Term relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateReplacementTermRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm, Boolean isReplace)` Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateSynonymRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym, Boolean isReplace)` Update a Synonym relationship which is a link between glossary terms that have the same meaning
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateTermCategorizationRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermCategorizationRelationship isatypeof, Boolean isReplace)` Update a termCategorization Relationship.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateTermHASARelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermHASARelationship termHASARelationship, Boolean isReplace)` Update a TermHASARelationship is the relationship between a spine object and a spine attribute.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateTermTYPEDBYRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermTYPEDBYRelationship termTYPEDBYRelationship, Boolean isReplace)` Update a TermTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateTranslationRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateUsedInContextRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
`org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse`	`updateValidValueRelationship(String serverName, String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue, Boolean isReplace)` Update a ValidValue relationship which is a link between glossary terms that have the same meaning

Methods inherited from class org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServicesInstance
getRelationshipsFromGuid, initializeAPI, initializeAPI, setOMRSAPIHelper

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

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

Method Detail

createTermHASARelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/has-as")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createTermHASARelationship(@PathVariable
                                                                                                                                                                                                                  String serverName,
                                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                                  String userId,
                                                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermHASARelationship termHASARelationship)

Create a TermHASARelationship is the relationship between a spine object and a spine attribute. Note that this method does not error if the relationship ends are not spine objects or spine attributes. This allows the user to create terms then make them spine objects and spine attributes at a later stage.

Parameters:

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

userId - userId under which the request is performed

termHASARelationship - the HASA relationship

Returns:

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

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

getTermHASARelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/has-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateTermHASARelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/has-as")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateTermHASARelationship(@PathVariable
                                                                                                                                                                                                                 String serverName,
                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                                 @RequestBody
                                                                                                                                                                                                                 org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermHASARelationship termHASARelationship,
                                                                                                                                                                                                                 @RequestParam(value="isReplace",required=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

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.
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

deleteTermHASARelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/has-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTermHASARelationship(@PathVariable
                                                                                                                                                                                                                           String serverName,
                                                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                                                           String userId,
                                                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                                                           String guid,
                                                                                                                                                                                                                           @RequestParam(value="isPurge",required=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 which when successful contains the term has a relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreTermHASARelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/has-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

createRelatedTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/related-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createRelatedTerm(@PathVariable
                                                                                                                                                                                                                String serverName,
                                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                                String userId,
                                                                                                                                                                                                                @RequestBody
                                                                                                                                                                                                                org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationshipRelationship)

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

relatedTermRelationshipRelationship - 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.
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

getRelatedTerm

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/related-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateRelatedTerm

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/related-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateRelatedTerm(@PathVariable
                                                                                                                                                                                                               String serverName,
                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                               String userId,
                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                               org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.RelatedTerm relatedTermRelationship,
                                                                                                                                                                                                               @RequestParam(value="isReplace",required=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

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.
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

deleteRelatedTerm

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/related-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteRelatedTerm(@PathVariable
                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String guid,
                                                                                                                                                                                                                         @RequestParam(value="isPurge",required=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 which when successful contains the related term relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreRelatedTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/related-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

createSynonym

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/synonyms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createSynonym(@PathVariable
                                                                                                                                                                                                       String serverName,
                                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                       org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym)

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

Parameters:

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

userId - userId under which the request is performed

synonym - the Synonym relationship

Returns:

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

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

getSynonymRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/synonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateSynonymRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/synonyms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateSynonymRelationship(@PathVariable
                                                                                                                                                                                                                  String serverName,
                                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                                  String userId,
                                                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Synonym synonym,
                                                                                                                                                                                                                  @RequestParam(value="isReplace",required=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

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.
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

deleteSynonymRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/synonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteSynonymRelationship(@PathVariable
                                                                                                                                                                                                                            String serverName,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            String guid,
                                                                                                                                                                                                                            @RequestParam(value="isPurge",required=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 which when successful contains the Synonym relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreSynonym

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/synonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createAntonym

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/antonyms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createAntonym(@PathVariable
                                                                                                                                                                                                       String serverName,
                                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                       org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym)

Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.

Parameters:

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

userId - userId under which the request is performed

antonym - the Antonym relationship

Returns:

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

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

getAntonymRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/antonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateAntonymRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/antonyms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateAntonymRelationship(@PathVariable
                                                                                                                                                                                                                  String serverName,
                                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                                  String userId,
                                                                                                                                                                                                                  @RequestBody
                                                                                                                                                                                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Antonym antonym,
                                                                                                                                                                                                                  @RequestParam(value="isReplace",required=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

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.
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

deleteAntonymRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/antonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteAntonymRelationship(@PathVariable
                                                                                                                                                                                                                            String serverName,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                                            String guid,
                                                                                                                                                                                                                            @RequestParam(value="isPurge",required=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 which when successful contains the Antonym relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreAntonym

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/antonyms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createTranslation

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/translations")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createTranslation(@PathVariable
                                                                                                                                                                                                               String serverName,
                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                               String userId,
                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                               org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
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

getTranslationRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/translations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateTranslationRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/translations")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateTranslationRelationship(@PathVariable
                                                                                                                                                                                                                          String serverName,
                                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                                          @RequestBody
                                                                                                                                                                                                                          org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.Translation translation,
                                                                                                                                                                                                                          @RequestParam(value="isReplace",required=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

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.
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

deleteTranslationRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/translations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTranslationRelationship(@PathVariable
                                                                                                                                                                                                                                    String serverName,
                                                                                                                                                                                                                                    @PathVariable
                                                                                                                                                                                                                                    String userId,
                                                                                                                                                                                                                                    @PathVariable
                                                                                                                                                                                                                                    String guid,
                                                                                                                                                                                                                                    @RequestParam(value="isPurge",required=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 which when successful contains the Translation relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreTranslation

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/translations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createusedInContext

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/used-in-contexts")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createusedInContext(@PathVariable
                                                                                                                                                                                                                     String serverName,
                                                                                                                                                                                                                     @PathVariable
                                                                                                                                                                                                                     String userId,
                                                                                                                                                                                                                     @RequestBody
                                                                                                                                                                                                                     org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
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

getUsedInContextRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/used-in-contexts/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateUsedInContextRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/used-in-contexts")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateUsedInContextRelationship(@PathVariable
                                                                                                                                                                                                                                String serverName,
                                                                                                                                                                                                                                @PathVariable
                                                                                                                                                                                                                                String userId,
                                                                                                                                                                                                                                @RequestBody
                                                                                                                                                                                                                                org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.UsedInContext usedInContext,
                                                                                                                                                                                                                                @RequestParam(value="isReplace",required=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

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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised
ClassificationException Error processing a classification
StatusNotSupportedException A status value is not supported

deleteUsedInContextRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/used-in-contexts/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteUsedInContextRelationship(@PathVariable
                                                                                                                                                                                                                                          String serverName,
                                                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                                                          String userId,
                                                                                                                                                                                                                                          @PathVariable
                                                                                                                                                                                                                                          String guid,
                                                                                                                                                                                                                                          @RequestParam(value="isPurge",required=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 which when successful contains the UsedInContext relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreUsedInContext

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/used-in-contexts/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createpreferredTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/preferred-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createpreferredTerm(@PathVariable
                                                                                                                                                                                                                    String serverName,
                                                                                                                                                                                                                    @PathVariable
                                                                                                                                                                                                                    String userId,
                                                                                                                                                                                                                    @RequestBody
                                                                                                                                                                                                                    org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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 Synonym 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.
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

getPreferredTermRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/preferred-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updatePreferredTermRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/preferred-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updatePreferredTermRelationship(@PathVariable
                                                                                                                                                                                                                               String serverName,
                                                                                                                                                                                                                               @PathVariable
                                                                                                                                                                                                                               String userId,
                                                                                                                                                                                                                               @RequestBody
                                                                                                                                                                                                                               org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.PreferredTerm preferredTerm,
                                                                                                                                                                                                                               @RequestParam(value="isReplace",required=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

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

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/preferred-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deletePreferredTermRelationship(@PathVariable
                                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                                         String guid,
                                                                                                                                                                                                                                         @RequestParam(value="isPurge",required=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 which when successful contains the PreferredTerm relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restorePreferredTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/preferred-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createvalidValue

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/valid-values")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createvalidValue(@PathVariable
                                                                                                                                                                                                              String serverName,
                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                              org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
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

getValidValueRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/valid-values/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateValidValueRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/valid-values")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateValidValueRelationship(@PathVariable
                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                         org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ValidValue validValue,
                                                                                                                                                                                                                         @RequestParam(value="isReplace",required=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

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.
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

deleteValidValueRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/valid-values/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteValidValueRelationship(@PathVariable
                                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                                   String guid,
                                                                                                                                                                                                                                   @RequestParam(value="isPurge",required=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 which when successful contains the ValidValue relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreValidValue

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/valid-values/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createreplacementTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/replacement-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createreplacementTerm(@PathVariable
                                                                                                                                                                                                                        String serverName,
                                                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                                                        String userId,
                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                        org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.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.
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

getReplacementTermRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/replacement-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
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

updateReplacementTermRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/replacement-terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateReplacementTermRelationship(@PathVariable
                                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ReplacementTerm replacementTerm,
                                                                                                                                                                                                                                   @RequestParam(value="isReplace",required=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

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.
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

deleteReplacementTermRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/replacement-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteReplacementTermRelationship(@PathVariable
                                                                                                                                                                                                                                             String serverName,
                                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                                             String userId,
                                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                                             String guid,
                                                                                                                                                                                                                                             @RequestParam(value="isPurge",required=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 which when successful contains the ReplacementTerm relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreReplacementTerm

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/replacement-terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createtermTYPEDBYRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/typed-bys")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createtermTYPEDBYRelationship(@PathVariable
                                                                                                                                                                                                                        String serverName,
                                                                                                                                                                                                                        @PathVariable
                                                                                                                                                                                                                        String userId,
                                                                                                                                                                                                                        @RequestBody
                                                                                                                                                                                                                        org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermTYPEDBYRelationship termTYPEDBYRelationship)

Create a termTYPEDBYRelationship relationship, which is a link between a spine attribute and its type.

Parameters:

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

userId - userId under which the request is performed

termTYPEDBYRelationship - the TermTYPEDBYRelationship relationship

Returns:

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

getTYPEDBYRelationshipRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/typed-bys/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse getTYPEDBYRelationshipRelationship(@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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateTermTYPEDBYRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/typed-bys")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateTermTYPEDBYRelationship(@PathVariable
                                                                                                                                                                                                                       String serverName,
                                                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                       @RequestBody
                                                                                                                                                                                                                       org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermTYPEDBYRelationship termTYPEDBYRelationship,
                                                                                                                                                                                                                       @RequestParam(value="isReplace",required=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

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 TermTYPEDBYRelationshipRelationship 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

deleteTypedByRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/typed-bys/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTypedByRelationship(@PathVariable
                                                                                                                                                                                                                             String serverName,
                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                             String userId,
                                                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                                                             String guid,
                                                                                                                                                                                                                             @RequestParam(value="isPurge",required=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 which when successful contains the TermTYPEDBYRelationship relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreTermTYPEDBYRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/typed-bys/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createiSARelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/is-as")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createiSARelationship(@PathVariable
                                                                                                                                                                                                            String serverName,
                                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                                            String userId,
                                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                                            org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ISARelationship 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.
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

getISARelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/is-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateISARelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/is-as")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateISARelationship(@PathVariable
                                                                                                                                                                                                           String serverName,
                                                                                                                                                                                                           @PathVariable
                                                                                                                                                                                                           String userId,
                                                                                                                                                                                                           @RequestBody
                                                                                                                                                                                                           org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.ISARelationship isa,
                                                                                                                                                                                                           @RequestParam(value="isReplace",required=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

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 ISARelationshipRelationship 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

deleteTermISARelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/is-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTermISARelationship(@PathVariable
                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                         String guid,
                                                                                                                                                                                                                         @RequestParam(value="isPurge",required=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 which when successful contains the ISARelationship relationship with the requested guid when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreIsaRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/is-as/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createtermISATypeOFRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/is-a-type-ofs")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createtermISATypeOFRelationship(@PathVariable
                                                                                                                                                                                                                              String serverName,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                                              org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermISATypeOFRelationship termISATypeOFRelationship)

Create a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.

Parameters:

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

userId - userId under which the request is performed

termISATypeOFRelationship - the TermISATypeOFRelationship relationship

Returns:

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

getTermISATypeOFRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/is-a-type-ofs/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse getTermISATypeOFRelationship(@PathVariable
                                                                                                                                                                                                                                 String serverName,
                                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                                 String userId,
                                                                                                                                                                                                                                 @PathVariable
                                                                                                                                                                                                                                 String guid)

Get a termISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.

Parameters:

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

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

guid - guid of the termISATypeOFRelationship relationship to get

Returns:

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

UserNotAuthorizedException the requesting user is not authorized to issue this request.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateISARelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/is-a-type-ofs")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateISARelationship(@PathVariable
                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermISATypeOFRelationship isatypeof,
                                                                                                                                                                                                                   @RequestParam(value="isReplace",required=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

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 ISARelationshipRelationship 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

deleteTermIsaTypeOfRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/is-a-type-ofs/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTermIsaTypeOfRelationship(@PathVariable
                                                                                                                                                                                                                                       String serverName,
                                                                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                                                                       String userId,
                                                                                                                                                                                                                                       @PathVariable
                                                                                                                                                                                                                                       String guid,
                                                                                                                                                                                                                                       @RequestParam(value="isPurge",required=false)
                                                                                                                                                                                                                                       Boolean isPurge)

Delete a TermISATypeOFRelationship relationship, which is an inheritance relationship between two spine objects.

Parameters:

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

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

guid - guid of the TermISATypeOFRelationship relationship to delete

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

Returns:

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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreTermIsaTypeOfRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/is-a-type-ofs/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse restoreTermIsaTypeOfRelationship(@PathVariable
                                                                                                                                                                                                                                      String serverName,
                                                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                                                      String userId,
                                                                                                                                                                                                                                      @PathVariable
                                                                                                                                                                                                                                      String guid)

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

Parameters:

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 TermIsaTypeOfRelationship when not successful the following Exception responses can occur

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

createTermCategorization

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/term-categorizations")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createTermCategorization(@PathVariable
                                                                                                                                                                                                                              String serverName,
                                                                                                                                                                                                                              @PathVariable
                                                                                                                                                                                                                              String userId,
                                                                                                                                                                                                                              @RequestBody
                                                                                                                                                                                                                              org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermCategorizationRelationship termCategorizationRelationship)

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

Parameters:

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

userId - userId under which the request is performed

termCategorizationRelationship - the TermCategorizationRelationship relationship

Returns:

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

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

getTermCategorizationRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/term-categorizations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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 termCategorizationRelationship relationship to get

Returns:

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

UserNotAuthorizedException the requesting user is not authorized to issue this request.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

updateTermCategorizationRelationship

@RequestMapping(method=PUT,
                path="/users/{userId}/relationships/term-categorizations")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateTermCategorizationRelationship(@PathVariable
                                                                                                                                                                                                                                         String serverName,
                                                                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                                                                         String userId,
                                                                                                                                                                                                                                         @RequestBody
                                                                                                                                                                                                                                         org.odpi.openmetadata.accessservices.subjectarea.properties.relationships.TermCategorizationRelationship isatypeof,
                                                                                                                                                                                                                                         @RequestParam(value="isReplace",required=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

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 termCategorization 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

deleteTermCategorizationRelationship

@RequestMapping(method=DELETE,
                path="/users/{userId}/relationships/term-categorizations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTermCategorizationRelationship(@PathVariable
                                                                                                                                                                                                                                                   String serverName,
                                                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                                                   String userId,
                                                                                                                                                                                                                                                   @PathVariable
                                                                                                                                                                                                                                                   String guid,
                                                                                                                                                                                                                                                   @RequestParam(value="isPurge",required=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 TermCategorizationRelationship relationship to delete

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

Returns:

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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.
EntityNotDeletedException a soft delete was issued but the relationship was not deleted.
GUIDNotPurgedException a hard delete was issued but the relationship was not purged

restoreTermCategorizationRelationship

@RequestMapping(method=POST,
                path="/users/{userId}/relationships/term-categorizations/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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

UnrecognizedGUIDException the supplied guid was not recognised
UserNotAuthorizedException the requesting user is not authorized to issue this request.
FunctionNotSupportedException Function not supported this indicates that a soft delete was issued but the repository does not support it.
InvalidParameterException one of the parameters is null or invalid.
MetadataServerUncontactableException not able to communicate with a Metadata respository service. There is a problem retrieving properties from the metadata repository.

getSemanticAssignmentRelationship

@RequestMapping(method=GET,
                path="/users/{userId}/relationships/semantic-assignments/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse 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.
MetadataServerUncontactableException not able to communicate with a Metadata respository service.
InvalidParameterException one of the parameters is null or invalid.
UnrecognizedGUIDException the supplied guid was not recognised

Class SubjectAreaRelationshipRESTResource

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

SubjectAreaRelationshipRESTResource

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

getTYPEDBYRelationshipRelationship

updateTermTYPEDBYRelationship

deleteTypedByRelationship

restoreTermTYPEDBYRelationship

createiSARelationship

getISARelationship

updateISARelationship

deleteTermISARelationship

restoreIsaRelationship

createtermISATypeOFRelationship

getTermISATypeOFRelationship

updateISARelationship

deleteTermIsaTypeOfRelationship

restoreTermIsaTypeOfRelationship

createTermCategorization

getTermCategorizationRelationship

updateTermCategorizationRelationship

deleteTermCategorizationRelationship

restoreTermCategorizationRelationship

getSemanticAssignmentRelationship