Class SubjectAreaRelationshipRESTResource
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateAntonym
(String serverName, String userId, Antonym antonym) Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.createCategoryHierarchyLink
(String serverName, String userId, CategoryHierarchyLink categoryHierarchyLink) Create a CategoryHierarchyLink Relationship.createiSARelationship
(String serverName, String userId, IsA iSARelationship) Create a iSARelationship, which is a link between a more general glossary term and a more specific definition.createIsATypeOf
(String serverName, String userId, IsATypeOf IsATypeOf) Create a IsATypeOf relationship, which is an inheritance relationship between two spine objects.createPreferredTerm
(String serverName, String userId, PreferredTerm preferredTerm) Create a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.createProjectScopeRelationship
(String serverName, String userId, ProjectScope projectScope) Create a project scope relationship, which is a link between the project content and the project.createRelatedTerm
(String serverName, String userId, RelatedTerm relatedTermRelationship) Create a RelatedTerm.createReplacementTerm
(String serverName, String userId, ReplacementTerm replacementTerm) Create a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.createSynonym
(String serverName, String userId, Synonym synonym) Create a synonym relationship, which is a link between glossary terms that have the same meaning.createTermCategorization
(String serverName, String userId, Categorization termCategorizationRelationship) Create a termCategorization Relationship.createTermHasARelationship
(String serverName, String userId, HasA termHasARelationship) Create a TermHASARelationship is the relationship between a spine object and a spine attribute.createTermIsATypeOfRelationship
(String serverName, String userId, IsATypeOfDeprecated termIsATypeOfRelationship) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.createtermTypedByRelationship
(String serverName, String userId, TypedBy termTypedByRelationship) Create a termTypedByRelationship, which is a link between a spine attribute and its type.createTranslation
(String serverName, String userId, Translation translation) Create a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.createusedInContext
(String serverName, String userId, UsedInContext usedInContext) Create a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.createValidValue
(String serverName, String userId, ValidValue validValue) Create a validValue relationship, which is a link between glossary terms that have the same meaning.deleteAntonymRelationship
(String serverName, String userId, String guid) Delete a Antonym relationshipdeleteCategoryHierarchyLink
(String serverName, String userId, String guid) Delete a CategoryHierarchyLink Relationship.deletePreferredTermRelationship
(String serverName, String userId, String guid) Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.deleteProjectScopeRelationship
(String serverName, String userId, String guid) Delete a Project scope relationship which is a link between the project content and the project.deleteRelatedTerm
(String serverName, String userId, String guid) Delete a Related Term relationshipdeleteReplacementTermRelationship
(String serverName, String userId, String guid) Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.deleteSynonymRelationship
(String serverName, String userId, String guid) Delete a Synonym relationshipdeleteTermCategorizationRelationship
(String serverName, String userId, String guid) Delete a TermCategorization Relationship.deleteTermHasARelationship
(String serverName, String userId, String guid) Delete a Term HAS A relationshipdeleteTermIsARelationship
(String serverName, String userId, String guid) Delete a IsARelationship, which is a link between a more general glossary term and a more specific definition.deleteTermIsATypeOf
(String serverName, String userId, String guid) Delete a IsATypeOf, which is an inheritance relationship between two spine objects.deleteTermIsaTypeOfRelationship
(String serverName, String userId, String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.deleteTranslationRelationship
(String serverName, String userId, String guid) Delete a Translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.deleteTypedByRelationship
(String serverName, String userId, String guid) Delete a TermTypedByRelationship, which is a link between a spine attribute and its type.deleteUsedInContextRelationship
(String serverName, String userId, String guid) Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.deleteValidValueRelationship
(String serverName, String userId, String guid) Delete a ValidValue relationshipgetAntonymRelationship
(String serverName, String userId, String guid) Get a antonym relationshipgetCategoryAnchor
(String serverName, String userId, String guid) Get a categoryAnchor Relationship.getCategoryHierarchyLink
(String serverName, String userId, String guid) Get a CategoryHierarchyLink Relationship.getIsARelationship
(String serverName, String userId, String guid) Get a iSARelationship, which is a link between a more general glossary term and a more specific definition.getIsATypeOf
(String serverName, String userId, String guid) Get a IsATypeOf, which is an inheritance relationship between two spine objects.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.getProjectScopeRelationship
(String serverName, String userId, String guid) Get a project scope relationship, which is a link between the project content and the project.getRelatedTerm
(String serverName, String userId, String guid) Get a related Term relationship.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.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.getSynonymRelationship
(String serverName, String userId, String guid) Get a synonym relationship, which is a link between glossary terms that have the same meaning.getTermAnchorRelationship
(String serverName, String userId, String guid) Get a termAnchor Relationship.getTermCategorizationRelationship
(String serverName, String userId, String guid) Get a termCategorization Relationship.getTermHasARelationship
(String serverName, String userId, String guid) Get a Term HAS A relationshipgetTermIsATypeOfRelationship
(String serverName, String userId, String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.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.getTypedByRelationship
(String serverName, String userId, String guid) Get a termTypedByRelationship, which is a link between a spine attribute and its type.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.getValidValueRelationship
(String serverName, String userId, String guid) Get a validValue relationship, which is a link between glossary terms that have the same meaning.restoreAntonym
(String serverName, String userId, String guid) Restore a AntonymrestoreCategoryHierarchyLink
(String serverName, String userId, String guid) Restore a CategoryHierarchyLink Relationship.restoreIsaRelationship
(String serverName, String userId, String guid) Restore a Isa RelationshiprestorePreferredTerm
(String serverName, String userId, String guid) Restore a PreferredTermrestoreProjectScopeRelationship
(String serverName, String userId, String guid) Restore a ProjectScope, which is a link between the project content and the project.restoreRelatedTerm
(String serverName, String userId, String guid) Restore a related Term relationship.restoreReplacementTerm
(String serverName, String userId, String guid) Restore a ReplacementTermrestoreSynonym
(String serverName, String userId, String guid) Restore a SynonymrestoreTermCategorizationRelationship
(String serverName, String userId, String guid) Restore a TermCategorization Relationship.restoreTermHasARelationship
(String serverName, String userId, String guid) Restore a has a relationship.restoreTermIsATypeOf
(String serverName, String userId, String guid) Restore a 'object inheritances' RelationshiprestoreTermIsaTypeOfRelationship
(String serverName, String userId, String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.restoreTermTypedByRelationship
(String serverName, String userId, String guid) Restore a Term TYPED BY relationshiprestoreTranslation
(String serverName, String userId, String guid) Restore a TranslationrestoreUsedInContext
(String serverName, String userId, String guid) Restore a UsedInContextrestoreValidValue
(String serverName, String userId, String guid) Restore a ValidValueupdateAntonymRelationship
(String serverName, String userId, String guid, Antonym antonym, Boolean isReplace) Update a Antonym relationship which is a link between glossary terms that have the opposite meaningupdateCategoryHierarchyLink
(String serverName, String userId, String guid, CategoryHierarchyLink categoryHierarchyLink, Boolean isReplace) Update a CategoryHierarchyLink Relationship.Update a IsARelationship, which is a link between a more general glossary term and a more specific definition.updateIsARelationship
(String serverName, String userId, String guid, IsATypeOfDeprecated isatypeof, Boolean isReplace) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.updateIsATypeOf
(String serverName, String userId, String guid, IsATypeOf IsATypeOf, Boolean isReplace) Update a IsATypeOf, which is an inheritance relationship between two spine objects.updatePreferredTermRelationship
(String serverName, String userId, String guid, PreferredTerm preferredTerm, Boolean isReplace) Update a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.updateProjectScopeRelationship
(String serverName, String userId, String guid, ProjectScope projectScope, Boolean isReplace) Update a Project scope relationship which is a link between the project content and the project.updateRelatedTerm
(String serverName, String userId, String guid, RelatedTerm relatedTermRelationship, Boolean isReplace) Update a Related Term relationship.updateReplacementTermRelationship
(String serverName, String userId, String guid, ReplacementTerm replacementTerm, Boolean isReplace) Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.updateSynonymRelationship
(String serverName, String userId, String guid, Synonym synonym, Boolean isReplace) Update a Synonym relationship which is a link between glossary terms that have the same meaningupdateTermCategorizationRelationship
(String serverName, String userId, String guid, Categorization isatypeof, Boolean isReplace) Update a termCategorization Relationship.updateTermHasARelationship
(String serverName, String userId, String guid, HasA termHasARelationship, Boolean isReplace) Update a TermHasARelationship is the relationship between a spine object and a spine attribute.updateTermTypedByRelationship
(String serverName, String userId, String guid, TypedBy termTypedByRelationship, Boolean isReplace) Update a TermTypedByRelationship, which is a link between a spine attribute and its type.updateTranslationRelationship
(String serverName, String userId, String guid, Translation translation, Boolean isReplace) Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.updateUsedInContextRelationship
(String serverName, String userId, String guid, UsedInContext usedInContext, Boolean isReplace) Update a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.updateValidValueRelationship
(String serverName, String userId, String guid, ValidValue validValue, Boolean isReplace) Update a ValidValue relationship which is a link between glossary terms that have the same meaning
-
Constructor Details
-
SubjectAreaRelationshipRESTResource
public SubjectAreaRelationshipRESTResource()Default constructor
-
-
Method Details
-
createTermHasARelationship
@PostMapping(path="/users/{userId}/relationships/has-as") public SubjectAreaOMASAPIResponse<HasA> createTermHasARelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody HasA termHasARelationship) Create a TermHASARelationship is the relationship between a spine object and a spine attribute. Note that this method does not error if the relationship ends are not spine objects or spine attributes. This allows the user to create terms then make them spine objects and spine attributes at a later stage.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedtermHasARelationship
- the HASA relationship- Returns:
- response, when successful contains the created TermHASARelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTermHasARelationship
@GetMapping(path="/users/{userId}/relationships/has-as/{guid}") public SubjectAreaOMASAPIResponse<HasA> getTermHasARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a Term HAS A relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the HAS A relationship to get- Returns:
- response which when successful contains the term has a relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateTermHasARelationship
@PutMapping(path="/users/{userId}/relationships/has-as/{guid}") public SubjectAreaOMASAPIResponse<HasA> updateTermHasARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody HasA termHasARelationship, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a TermHasARelationship is the relationship between a spine object and a spine attribute.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshiptermHasARelationship
- the HASA relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created TermHasARelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTermHasARelationship
@DeleteMapping(path="/users/{userId}/relationships/has-as/{guid}") public SubjectAreaOMASAPIResponse<HasA> deleteTermHasARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a Term HAS A relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the HAS A relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTermHasARelationship
@PostMapping(path="/users/{userId}/relationships/has-as/{guid}") public SubjectAreaOMASAPIResponse<HasA> restoreTermHasARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a has a relationship.Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the relationship to restore- Returns:
- response which when successful contains the restored relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createRelatedTerm
@PostMapping(path="/users/{userId}/relationships/related-terms") public SubjectAreaOMASAPIResponse<RelatedTerm> createRelatedTerm(@PathVariable String serverName, @PathVariable String userId, @RequestBody RelatedTerm relatedTermRelationship) Create a RelatedTerm. A Related Term is a link between two similar Terms.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedrelatedTermRelationship
- the RelatedTerm relationship- Returns:
- response, when successful contains the created Related Term relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getRelatedTerm
@GetMapping(path="/users/{userId}/relationships/related-terms/{guid}") public SubjectAreaOMASAPIResponse<RelatedTerm> getRelatedTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a related Term relationship.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the related term relationship to get- Returns:
- response which when successful contains the related term relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateRelatedTerm
@PutMapping(path="/users/{userId}/relationships/related-terms/{guid}") public SubjectAreaOMASAPIResponse<RelatedTerm> updateRelatedTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody RelatedTerm relatedTermRelationship, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a Related Term relationship. A Related Term is a link between two similar Terms.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshiprelatedTermRelationship
- the related term relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created RelatedTerm
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteRelatedTerm
@DeleteMapping(path="/users/{userId}/relationships/related-terms/{guid}") public SubjectAreaOMASAPIResponse<RelatedTerm> deleteRelatedTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a Related Term relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Related term relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreRelatedTerm
@PostMapping(path="/users/{userId}/relationships/related-terms/{guid}") public SubjectAreaOMASAPIResponse<RelatedTerm> restoreRelatedTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a related Term relationship.Restore allows the deleted relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the relationship to restore- Returns:
- response which when successful contains the restored relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createSynonym
@PostMapping(path="/users/{userId}/relationships/synonyms") public SubjectAreaOMASAPIResponse<Synonym> createSynonym(@PathVariable String serverName, @PathVariable String userId, @RequestBody Synonym synonym) Create a synonym relationship, which is a link between glossary terms that have the same meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedsynonym
- the Synonym relationship- Returns:
- response, when successful contains the created synonym relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getSynonymRelationship
@GetMapping(path="/users/{userId}/relationships/synonyms/{guid}") public SubjectAreaOMASAPIResponse<Synonym> getSynonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a synonym relationship, which is a link between glossary terms that have the same meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the synonym relationship to get- Returns:
- response which when successful contains the synonym relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateSynonymRelationship
@PutMapping(path="/users/{userId}/relationships/synonyms/{guid}") public SubjectAreaOMASAPIResponse<Synonym> updateSynonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody Synonym synonym, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a Synonym relationship which is a link between glossary terms that have the same meaning- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipsynonym
- the synonym relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created SynonymRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteSynonymRelationship
@DeleteMapping(path="/users/{userId}/relationships/synonyms/{guid}") public SubjectAreaOMASAPIResponse<Synonym> deleteSynonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a Synonym relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Synonym relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreSynonym
@PostMapping(path="/users/{userId}/relationships/synonyms/{guid}") public SubjectAreaOMASAPIResponse<Synonym> restoreSynonym(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a SynonymRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Synonym to delete- Returns:
- response which when successful contains the restored Synonym
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createAntonym
@PostMapping(path="/users/{userId}/relationships/antonyms") public SubjectAreaOMASAPIResponse<Antonym> createAntonym(@PathVariable String serverName, @PathVariable String userId, @RequestBody Antonym antonym) Create an antonym relationship, which is a link between glossary terms that have the opposite meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedantonym
- the Antonym relationship- Returns:
- response, when successful contains the created antonym relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getAntonymRelationship
@GetMapping(path="/users/{userId}/relationships/antonyms/{guid}") public SubjectAreaOMASAPIResponse<Antonym> getAntonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a antonym relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the related term relationship to get- Returns:
- response which when successful contains the antonym relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateAntonymRelationship
@PutMapping(path="/users/{userId}/relationships/antonyms/{guid}") public SubjectAreaOMASAPIResponse<Antonym> updateAntonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody Antonym antonym, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a Antonym relationship which is a link between glossary terms that have the opposite meaning- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipantonym
- the antonym relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created AntonymRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteAntonymRelationship
@DeleteMapping(path="/users/{userId}/relationships/antonyms/{guid}") public SubjectAreaOMASAPIResponse<Antonym> deleteAntonymRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a Antonym relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Antonym relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreAntonym
@PostMapping(path="/users/{userId}/relationships/antonyms/{guid}") public SubjectAreaOMASAPIResponse<Antonym> restoreAntonym(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a AntonymRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Antonym to delete- Returns:
- response which when successful contains the restored Antonym
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createTranslation
@PostMapping(path="/users/{userId}/relationships/translations") public SubjectAreaOMASAPIResponse<Translation> createTranslation(@PathVariable String serverName, @PathVariable String userId, @RequestBody Translation translation) Create a translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedtranslation
- the Translation relationship- Returns:
- response, when successful contains the created translation relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTranslationRelationship
@GetMapping(path="/users/{userId}/relationships/translations/{guid}") public SubjectAreaOMASAPIResponse<Translation> getTranslationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a translation relationshiptranslation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the translation relationship to get- Returns:
- response which when successful contains the translation relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateTranslationRelationship
@PutMapping(path="/users/{userId}/relationships/translations/{guid}") public SubjectAreaOMASAPIResponse<Translation> updateTranslationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody Translation translation, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a Translation relationship translation relationship, which is a link between glossary terms to provide different natural language translation of the same concept.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshiptranslation
- the translation relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created TranslationRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTranslationRelationship
@DeleteMapping(path="/users/{userId}/relationships/translations/{guid}") public SubjectAreaOMASAPIResponse<Translation> deleteTranslationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Translation relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTranslation
@PostMapping(path="/users/{userId}/relationships/translations/{guid}") public SubjectAreaOMASAPIResponse<Translation> restoreTranslation(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a TranslationRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Translation to delete- Returns:
- response which when successful contains the restored Translation
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createusedInContext
@PostMapping(path="/users/{userId}/relationships/used-in-contexts") public SubjectAreaOMASAPIResponse<UsedInContext> createusedInContext(@PathVariable String serverName, @PathVariable String userId, @RequestBody UsedInContext usedInContext) Create a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedusedInContext
- the UsedInContext relationship- Returns:
- response, when successful contains the created usedInContext relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getUsedInContextRelationship
@GetMapping(path="/users/{userId}/relationships/used-in-contexts/{guid}") public SubjectAreaOMASAPIResponse<UsedInContext> getUsedInContextRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a usedInContext relationship, which is a link between glossary terms, where one describes the context where the other one is valid to use.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the usedInContext relationship to get- Returns:
- response which when successful contains the usedInContext relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateUsedInContextRelationship
@PutMapping(path="/users/{userId}/relationships/used-in-contexts/{guid}") public SubjectAreaOMASAPIResponse<UsedInContext> updateUsedInContextRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody UsedInContext usedInContext, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipusedInContext
- the used in context relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created UsedInContextRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteUsedInContextRelationship
@DeleteMapping(path="/users/{userId}/relationships/used-in-contexts/{guid}") public SubjectAreaOMASAPIResponse<UsedInContext> deleteUsedInContextRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a UsedInContext relationship which is a link between glossary terms, where one describes the context where the other one is valid to use.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the UsedInContext relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreUsedInContext
@PostMapping(path="/users/{userId}/relationships/used-in-contexts/{guid}") public SubjectAreaOMASAPIResponse<UsedInContext> restoreUsedInContext(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a UsedInContextRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the UsedInContext to delete- Returns:
- response which when successful contains the restored UsedInContext
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createPreferredTerm
@PostMapping(path="/users/{userId}/relationships/preferred-terms") public SubjectAreaOMASAPIResponse<PreferredTerm> createPreferredTerm(@PathVariable String serverName, @PathVariable String userId, @RequestBody PreferredTerm preferredTerm) Create a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedpreferredTerm
- the preferred term relationship- Returns:
- response, when successful contains the created preferredTerm relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getPreferredTermRelationship
@GetMapping(path="/users/{userId}/relationships/preferred-terms/{guid}") public SubjectAreaOMASAPIResponse<PreferredTerm> getPreferredTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a preferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the preferredTerm relationship to get- Returns:
- response which when successful contains the preferredTerm relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updatePreferredTermRelationship
@PutMapping(path="/users/{userId}/relationships/preferred-terms/{guid}") public SubjectAreaOMASAPIResponse<PreferredTerm> updatePreferredTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody PreferredTerm preferredTerm, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshippreferredTerm
- the preferred term relationshipisReplace
- 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.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deletePreferredTermRelationship
@DeleteMapping(path="/users/{userId}/relationships/preferred-terms/{guid}") public SubjectAreaOMASAPIResponse<PreferredTerm> deletePreferredTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a PreferredTerm relationship, which is a link between glossary terms, it is a Link to an alternative term that the organization prefers is used.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the PreferredTerm relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restorePreferredTerm
@PostMapping(path="/users/{userId}/relationships/preferred-terms/{guid}") public SubjectAreaOMASAPIResponse<PreferredTerm> restorePreferredTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a PreferredTermRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the PreferredTerm to delete- Returns:
- response which when successful contains the restored PreferredTerm
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createValidValue
@PostMapping(path="/users/{userId}/relationships/valid-values") public SubjectAreaOMASAPIResponse<ValidValue> createValidValue(@PathVariable String serverName, @PathVariable String userId, @RequestBody ValidValue validValue) Create a validValue relationship, which is a link between glossary terms that have the same meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedvalidValue
- the ValidValue relationship- Returns:
- response, when successful contains the created validValue relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getValidValueRelationship
@GetMapping(path="/users/{userId}/relationships/valid-values/{guid}") public SubjectAreaOMASAPIResponse<ValidValue> getValidValueRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a validValue relationship, which is a link between glossary terms that have the same meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the validValue relationship to get- Returns:
- response which when successful contains the validValue relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateValidValueRelationship
@PutMapping(path="/users/{userId}/relationships/valid-values/{guid}") public SubjectAreaOMASAPIResponse<ValidValue> updateValidValueRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody ValidValue validValue, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a ValidValue relationship which is a link between glossary terms that have the same meaning- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipvalidValue
- the valid value relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created ValidValueRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteValidValueRelationship
@DeleteMapping(path="/users/{userId}/relationships/valid-values/{guid}") public SubjectAreaOMASAPIResponse<ValidValue> deleteValidValueRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a ValidValue relationship- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the ValidValue relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreValidValue
@PostMapping(path="/users/{userId}/relationships/valid-values/{guid}") public SubjectAreaOMASAPIResponse<ValidValue> restoreValidValue(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a ValidValueRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the ValidValue to delete- Returns:
- response which when successful contains the restored ValidValue
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createReplacementTerm
@PostMapping(path="/users/{userId}/relationships/replacement-terms") public SubjectAreaOMASAPIResponse<ReplacementTerm> createReplacementTerm(@PathVariable String serverName, @PathVariable String userId, @RequestBody ReplacementTerm replacementTerm) Create a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedreplacementTerm
- the ReplacementTerm relationship- Returns:
- response, when successful contains the created replacementTerm relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getReplacementTermRelationship
@GetMapping(path="/users/{userId}/relationships/replacement-terms/{guid}") public SubjectAreaOMASAPIResponse<ReplacementTerm> getReplacementTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a replacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the replacementTerm relationship to get- Returns:
- response which when successful contains the replacementTerm relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateReplacementTermRelationship
@PutMapping(path="/users/{userId}/relationships/replacement-terms/{guid}") public SubjectAreaOMASAPIResponse<ReplacementTerm> updateReplacementTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody ReplacementTerm replacementTerm, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipreplacementTerm
- the replacement term relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created ReplacementTermRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteReplacementTermRelationship
@DeleteMapping(path="/users/{userId}/relationships/replacement-terms/{guid}") public SubjectAreaOMASAPIResponse<ReplacementTerm> deleteReplacementTermRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a ReplacementTerm relationship, which is a link to a glossary term that is replacing an obsolete glossary term.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the ReplacementTerm relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreReplacementTerm
@PostMapping(path="/users/{userId}/relationships/replacement-terms/{guid}") public SubjectAreaOMASAPIResponse<ReplacementTerm> restoreReplacementTerm(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a ReplacementTermRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the ReplacementTerm to delete- Returns:
- response which when successful contains the restored ReplacementTerm
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createtermTypedByRelationship
@PostMapping(path="/users/{userId}/relationships/typed-bys") public SubjectAreaOMASAPIResponse<TypedBy> createtermTypedByRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody TypedBy termTypedByRelationship) Create a termTypedByRelationship, 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 tenantuserId
- userId under which the request is performedtermTypedByRelationship
- the TermTypedByRelationship- Returns:
- response, when successful contains the created termTypedByRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTypedByRelationship
@GetMapping(path="/users/{userId}/relationships/typed-bys/{guid}") public SubjectAreaOMASAPIResponse<TypedBy> getTypedByRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a termTypedByRelationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the termTypedByRelationship to get- Returns:
- response which when successful contains the termTypedByRelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateTermTypedByRelationship
@PutMapping(path="/users/{userId}/relationships/typed-bys/{guid}") public SubjectAreaOMASAPIResponse<TypedBy> updateTermTypedByRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody TypedBy termTypedByRelationship, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a TermTypedByRelationship, 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 tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshiptermTypedByRelationship
- the typed by relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created TermTypedByRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTypedByRelationship
@DeleteMapping(path="/users/{userId}/relationships/typed-bys/{guid}") public SubjectAreaOMASAPIResponse<TypedBy> deleteTypedByRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a TermTypedByRelationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the TermTypedByRelationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTermTypedByRelationship
@PostMapping(path="/users/{userId}/relationships/typed-bys/{guid}") public SubjectAreaOMASAPIResponse<TypedBy> restoreTermTypedByRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a Term TYPED BY relationshipRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the TermTypedBy to delete- Returns:
- response which when successful contains the restored TermTypedBy
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createiSARelationship
@PostMapping(path="/users/{userId}/relationships/is-as") public SubjectAreaOMASAPIResponse<IsA> createiSARelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody IsA iSARelationship) Create a iSARelationship, 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 tenantuserId
- userId under which the request is performediSARelationship
- the IsARelationship- Returns:
- response, when successful contains the created iSARelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getIsARelationship
@GetMapping(path="/users/{userId}/relationships/is-as/{guid}") public SubjectAreaOMASAPIResponse<IsA> getIsARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a iSARelationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the iSARelationship to get- Returns:
- response which when successful contains the iSARelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateIsARelationship
@PutMapping(path="/users/{userId}/relationships/is-as/{guid}") public SubjectAreaOMASAPIResponse<IsA> updateIsARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody IsA isa, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a IsARelationship, 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 tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipisa
- the is-a relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created IsARelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTermIsARelationship
@DeleteMapping(path="/users/{userId}/relationships/is-as/{guid}") public SubjectAreaOMASAPIResponse<IsA> deleteTermIsARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a IsARelationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the IsARelationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreIsaRelationship
@PostMapping(path="/users/{userId}/relationships/is-as/{guid}") public SubjectAreaOMASAPIResponse<IsA> restoreIsaRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a Isa RelationshipRestore 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Isa Relationship to delete- Returns:
- response which when successful contains the restored IsaRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createTermIsATypeOfRelationship
@PostMapping(path="/users/{userId}/relationships/is-a-type-of-deprecateds") public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> createTermIsATypeOfRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody IsATypeOfDeprecated termIsATypeOfRelationship) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.Create a termIsATypeOfRelationship, 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 tenantuserId
- userId under which the request is performedtermIsATypeOfRelationship
- the TermIsATypeOfRelationship- Returns:
- response, when successful contains the created termIsATypeOfRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTermIsATypeOfRelationship
@GetMapping(path="/users/{userId}/relationships/is-a-type-of-deprecateds/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> getTermIsATypeOfRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.Get a termIsATypeOfRelationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the termIsATypeOfRelationship to get- Returns:
- response which when successful contains the termIsATypeOfRelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateIsARelationship
@PutMapping(path="/users/{userId}/relationships/is-a-type-of-deprecateds/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> updateIsARelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody IsATypeOfDeprecated isatypeof, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.Update a termIsATypeOfRelationship, 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 tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipisatypeof
- the is-a-type-of-deprecated relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created IsARelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTermIsaTypeOfRelationship
@DeleteMapping(path="/users/{userId}/relationships/is-a-type-of-deprecateds/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> deleteTermIsaTypeOfRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.Delete a TermIsATypeOf 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the TermIsATypeOfRelationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTermIsaTypeOfRelationship
@PostMapping(path="/users/{userId}/relationships/is-a-type-of-deprecateds/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOfDeprecated> restoreTermIsaTypeOfRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Deprecated.IsATypeOfRelationship it is deprecated; move your instances to use IsATypeOf instead.Restore allows the deleted Is a Type Of Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
Restore a TermIsATypeOf Relationship, 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- 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
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createIsATypeOf
@PostMapping(path="/users/{userId}/relationships/is-a-type-ofs") public SubjectAreaOMASAPIResponse<IsATypeOf> createIsATypeOf(@PathVariable String serverName, @PathVariable String userId, @RequestBody IsATypeOf IsATypeOf) Create a IsATypeOf relationship, which is an inheritance relationship between two spine objects.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedIsATypeOf
- the IsATypeOf- Returns:
- response, when successful contains the created IsATypeOf
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- MetadataServerUncontactableException not able to communicate with a Metadata respository service.
- InvalidParameterException one of the parameters is null or invalid.
- UnrecognizedGUIDException the supplied guid was not recognised
- ClassificationException Error processing a classification.
- StatusNotSupportedException A status value is not supported.
- FunctionNotSupportedException Function not supported.
-
getIsATypeOf
@GetMapping(path="/users/{userId}/relationships/is-a-type-ofs/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOf> getIsATypeOf(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a IsATypeOf, which is an inheritance relationship between two spine objects.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the IsATypeOf to get- Returns:
- response which when successful contains the IsATypeOf with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateIsATypeOf
@PutMapping(path="/users/{userId}/relationships/is-a-type-ofs/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOf> updateIsATypeOf(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody IsATypeOf IsATypeOf, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a IsATypeOf, 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 tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipIsATypeOf
- the is-a-type-ofs relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created IsATypeOf
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTermIsATypeOf
@DeleteMapping(path="/users/{userId}/relationships/is-a-type-ofs/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOf> deleteTermIsATypeOf(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a IsATypeOf, which is an inheritance relationship between two spine objects.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the IsATypeOf relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTermIsATypeOf
@PostMapping(path="/users/{userId}/relationships/is-a-type-ofs/{guid}") public SubjectAreaOMASAPIResponse<IsATypeOf> restoreTermIsATypeOf(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a 'object inheritances' RelationshipRestore allows the deleted 'object inheritances' 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 tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Term Is a Type Of Relationship to delete- Returns:
- response which when successful contains the restoredIsATypeOf
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createTermCategorization
@PostMapping(path="/users/{userId}/relationships/term-categorizations") public SubjectAreaOMASAPIResponse<Categorization> createTermCategorization(@PathVariable String serverName, @PathVariable String userId, @RequestBody Categorization termCategorizationRelationship) Create a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedtermCategorizationRelationship
- the TermCategorizationRelationship- Returns:
- response, when successful contains the created termCategorizationRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTermCategorizationRelationship
@GetMapping(path="/users/{userId}/relationships/term-categorizations/{guid}") public SubjectAreaOMASAPIResponse<Categorization> getTermCategorizationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the termCategorizationRelationship to get- Returns:
- response which when successful contains the termCategorizationRelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateTermCategorizationRelationship
@PutMapping(path="/users/{userId}/relationships/term-categorizations/{guid}") public SubjectAreaOMASAPIResponse<Categorization> updateTermCategorizationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody Categorization isatypeof, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a termCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipisatypeof
- the is-a-type-of relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created termCategorization Relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteTermCategorizationRelationship
@DeleteMapping(path="/users/{userId}/relationships/term-categorizations/{guid}") public SubjectAreaOMASAPIResponse<Categorization> deleteTermCategorizationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a TermCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the TermCategorizationRelationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreTermCategorizationRelationship
@PostMapping(path="/users/{userId}/relationships/term-categorizations/{guid}") public SubjectAreaOMASAPIResponse<Categorization> restoreTermCategorizationRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a TermCategorization Relationship. A relationship between a Category and a Term. This relationship allows terms to be categorized.Restore allows the deleted TermCategorization Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Term Is a Type Of Relationship to delete- Returns:
- response which when successful contains the restored TermCategorization
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getTermAnchorRelationship
@GetMapping(path="/users/{userId}/relationships/term-anchor/{guid}") public SubjectAreaOMASAPIResponse<TermAnchor> getTermAnchorRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a termAnchor Relationship. A relationship between a Glossary and a Term. This relationship allows terms to be owned by a Glossary.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the termAnchor Relationship to get- Returns:
- response which when successful contains the termAnchorRelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getCategoryAnchor
@GetMapping(path="/users/{userId}/relationships/category-anchor/{guid}") public SubjectAreaOMASAPIResponse<CategoryAnchor> getCategoryAnchor(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a categoryAnchor Relationship. A relationship between a Glossary and a Category. This relationship allows terms to be owned by a Glossary.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the categoryAnchor Relationship to get- Returns:
- response which when successful contains the categoryAnchorRelationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createProjectScopeRelationship
@PostMapping(path="/users/{userId}/relationships/project-scopes") public SubjectAreaOMASAPIResponse<ProjectScope> createProjectScopeRelationship(@PathVariable String serverName, @PathVariable String userId, @RequestBody ProjectScope projectScope) Create a project scope relationship, which is a link between the project content and the project.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedprojectScope
- the Project scope relationship- Returns:
- response, when successful contains the created project scope relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getProjectScopeRelationship
@GetMapping(path="/users/{userId}/relationships/project-scopes/{guid}") public SubjectAreaOMASAPIResponse<ProjectScope> getProjectScopeRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a project scope relationship, which is a link between the project content and the project.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the project scope relationship to get- Returns:
- response which when successful contains the project scope relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateProjectScopeRelationship
@PutMapping(path="/users/{userId}/relationships/project-scopes/{guid}") public SubjectAreaOMASAPIResponse<ProjectScope> updateProjectScopeRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody ProjectScope projectScope, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a Project scope relationship which is a link between the project content and the project.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- unique identifier of the relationshipprojectScope
- the projectScope relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the created ProjectScopeRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteProjectScopeRelationship
@DeleteMapping(path="/users/{userId}/relationships/project-scopes/{guid}") public SubjectAreaOMASAPIResponse<ProjectScope> deleteProjectScopeRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a Project scope relationship which is a link between the project content and the project.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the Project scope relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreProjectScopeRelationship
@PostMapping(path="/users/{userId}/relationships/project-scopes/{guid}") public SubjectAreaOMASAPIResponse<ProjectScope> restoreProjectScopeRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a ProjectScope, which is a link between the project content and the project.Restore allows the deleted ProjectScopeRelationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the ProjectScopeRelationship to delete- Returns:
- response which when successful contains the restored ProjectScopeRelationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getSemanticAssignmentRelationship
@GetMapping(path="/users/{userId}/relationships/semantic-assignments/{guid}") public SubjectAreaOMASAPIResponse<SemanticAssignment> getSemanticAssignmentRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a SemanticAssignment relationship, Links a glossary term to another element such as an asset or schema element to define its meaning.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the SemanticAssignment relationship to get- Returns:
- response which when successful contains the SemanticAssignment relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
createCategoryHierarchyLink
@PostMapping(path="/users/{userId}/relationships/category-hierarchy-link") public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> createCategoryHierarchyLink(@PathVariable String serverName, @PathVariable String userId, @RequestBody CategoryHierarchyLink categoryHierarchyLink) Create a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedcategoryHierarchyLink
- the CategoryHierarchyLink relationship- Returns:
- response, when successful contains the created categoryHierarchyLink relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
getCategoryHierarchyLink
@GetMapping(path="/users/{userId}/relationships/category-hierarchy-link/{guid}") public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> getCategoryHierarchyLink(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Get a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the CategoryHierarchyLink Relationship to get- Returns:
- response which when successful contains the CategoryHierarchyLink relationship with the requested guid
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
updateCategoryHierarchyLink
@PutMapping(path="/users/{userId}/relationships/category-hierarchy-link/{guid}") public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> updateCategoryHierarchyLink(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid, @RequestBody CategoryHierarchyLink categoryHierarchyLink, @RequestParam(value="isReplace",required=false,defaultValue="false") Boolean isReplace) Update a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- userId under which the request is performedguid
- guid of the CategoryHierarchyLink relationshipcategoryHierarchyLink
- the CategoryHierarchyLink relationshipisReplace
- flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated.- Returns:
- response, when successful contains the updated categoryHierarchyLink
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
deleteCategoryHierarchyLink
@DeleteMapping(path="/users/{userId}/relationships/category-hierarchy-link/{guid}") public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> deleteCategoryHierarchyLink(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Delete a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the CategoryHierarchyLink relationship to delete- Returns:
- response for a soft delete the response contains the deleted relationship
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-
restoreCategoryHierarchyLink
@PostMapping(path="/users/{userId}/relationships/category-hierarchy-link/{guid}") public SubjectAreaOMASAPIResponse<CategoryHierarchyLink> restoreCategoryHierarchyLink(@PathVariable String serverName, @PathVariable String userId, @PathVariable String guid) Restore a CategoryHierarchyLink Relationship. A relationship between two categories used to create nested categories.Restore allows the deleted CategoryHierarchyLink Relationship to be made active again. Restore allows deletes to be undone. Hard deletes are not stored in the repository so cannot be restored.
- Parameters:
serverName
- serverName under which this request is performed, this is used in multi tenanting to identify the tenantuserId
- unique identifier for requesting user, under which the request is performedguid
- guid of the CategoryHierarchyLink Relationship to delete- Returns:
- response which when successful contains the restored CategoryHierarchyLink
when not successful the following Exception responses can occur
- UserNotAuthorizedException the requesting user is not authorized to issue this request.
- InvalidParameterException one of the parameters is null or invalid.
- PropertyServerException Property server exception.
-