org.odpi.openmetadata.accessservices.subjectarea.server.spring

Class SubjectAreaTermRESTResource

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.server.services.SubjectAreaRESTServices

org.odpi.openmetadata.accessservices.subjectarea.server.spring.SubjectAreaTermRESTResource

@RestController
 @RequestMapping(value="/open-metadata/access-services/subject-area")
public class SubjectAreaTermRESTResource
extends SubjectAreaRESTServices

The SubjectAreaRESTServices provides the org.odpi.openmetadata.accessservices.subjectarea.server-side implementation of the SubjectArea Open Metadata Assess Service (OMAS). This interface provides term authoring interfaces for subject area experts.

Field Summary

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

oMRSAPIHelper

Constructor Summary

Constructors

Constructor and Description
SubjectAreaTermRESTResource() Default constructor

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	createTerm(String userId, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term suppliedTerm) Create a Term The qualifiedName can be specified and will be honoured.
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	deleteTerm(String userId, String guid, Boolean isPurge) Delete a Term instance
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	getTermByGuid(String userId, String guid) Get a Term
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	updateTerm(String userId, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term suppliedTerm, Boolean isReplace) Update a Term

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

getPossibleClassificationsForTerm, getPossibleRelationshipsForTerm, getRepositoryConnector, setOMRSAPIHelper, setRepositoryConnector

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubjectAreaTermRESTResource

public SubjectAreaTermRESTResource()

Default constructor

Method Detail

createTerm

@RequestMapping(method=POST,
                path="/users/{userId}/terms")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createTerm(@PathVariable
                                                                                                                                                                                   String userId,
                                                                                                                                                                                   @RequestBody
                                                                                                                                                                                   org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term suppliedTerm)

Create a Term The qualifiedName can be specified and will be honoured. If it is specified then the caller may wish to ensure that it is unique. If this qualifiedName is not specified then one will be generated as GlossaryTerm concatinated with the guid. Failure to create the Terms classifications, link to its glossary or its icon, results in the create failing and the term being deleted

Parameters:

userId - userId

suppliedTerm - term to create

Returns:

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

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

getTermByGuid

@RequestMapping(method=GET,
                path="/users/{userId}/terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse getTermByGuid(@PathVariable
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String guid)

Get a Term

Parameters:

userId - userId under which the request is performed

guid - guid of the term to get

Returns:

a response which when successful contains the term when not successful the following Exception responses can occur

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

updateTerm

@RequestMapping(method=PUT,
                path="/users/{userId}/terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateTerm(@PathVariable
                                                                                                                                                                                         String userId,
                                                                                                                                                                                         @PathVariable
                                                                                                                                                                                         String guid,
                                                                                                                                                                                         org.odpi.openmetadata.accessservices.subjectarea.properties.objects.term.Term suppliedTerm,
                                                                                                                                                                                         @RequestParam(value="isReplace",required=false)
                                                                                                                                                                                         Boolean isReplace)

Update a Term

Status is not updated using this call.

Parameters:

userId - userId under which the request is performed

guid - guid of the term to update

suppliedTerm - term to be updated

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

Returns:

a response which when successful contains the updated term when not successful the following Exception responses can occur

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

deleteTerm

@RequestMapping(method=DELETE,
                path="/users/{userId}/terms/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse deleteTerm(@PathVariable
                                                                                                                                                                                            String userId,
                                                                                                                                                                                            @PathVariable
                                                                                                                                                                                            String guid,
                                                                                                                                                                                            @RequestParam(value="isPurge",required=false)
                                                                                                                                                                                            Boolean isPurge)

Delete a Term instance

There are 2 types of deletion, a soft delete and a hard delete (also known as a purge). All repositories support hard deletes. Soft deletes support is optional. Soft delete is the default.

A soft delete means that the term instance will exist in a deleted state in the repository after the delete operation. This means that it is possible to undo the delete. A hard delete means that the term will not exist after the operation. when not successful the following Exceptions can occur

Parameters:

userId - userId under which the request is performed

guid - guid of the term to be deleted.

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

Returns:

a response which when successful contains a void response when not successful the following Exception responses can occur

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