org.odpi.openmetadata.userinterface.uichassis.springboot.api.subjectarea

Class SubjectAreaTermController

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

org.odpi.openmetadata.userinterface.uichassis.springboot.api.subjectarea.SubjectAreaTermController

@RestController
 @RequestMapping(value="/api/subject-area/terms")
public class SubjectAreaTermController
extends SecureController

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

Constructor Summary

Constructors

Constructor and Description
SubjectAreaTermController(SubjectArea subjectArea) Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createTerm(Term suppliedTerm, javax.servlet.http.HttpServletRequest request) /** Create a Term
SubjectAreaOMASAPIResponse	deleteTerm(String guid, Boolean isPurge, javax.servlet.http.HttpServletRequest request) Delete a Term instance
SubjectAreaOMASAPIResponse	findTerm(String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request) Find Term
SubjectAreaOMASAPIResponse	getTerm(String guid, javax.servlet.http.HttpServletRequest request) Get a term.
SubjectAreaOMASAPIResponse	getTermRelationships(String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request)
SubjectAreaOMASAPIResponse	restoreTerm(String guid, javax.servlet.http.HttpServletRequest request) Restore a Term Restore allows the deleted Term to be made active again.
SubjectAreaOMASAPIResponse	updateTerm(String guid, Term term, Boolean isReplace, javax.servlet.http.HttpServletRequest request) Update a Term

Methods inherited from class org.odpi.openmetadata.userinterface.uichassis.springboot.api.SecureController

getUser

Methods inherited from class java.lang.Object

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

Constructor Detail

SubjectAreaTermController

public SubjectAreaTermController(SubjectArea subjectArea)

Default constructor

Parameters:

subjectArea - main client object for the Subject Area OMAS

Method Detail

createTerm

@PostMapping
public SubjectAreaOMASAPIResponse createTerm(@RequestBody
                                                          Term suppliedTerm,
                                                          javax.servlet.http.HttpServletRequest request)

/** Create a Term

The name needs to be specified - as this is the main identifier for the term. The name should be unique for canonical glossaries. This API does not police the uniqueness in this case.

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

suppliedTerm - Term to create

request - Servlet request

Returns:

response, when successful contains the created term.

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

getTerm

@GetMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse getTerm(@PathVariable
                                                                      String guid,
                                                                      javax.servlet.http.HttpServletRequest request)

Get a term.

Parameters:

guid - guid of the term to get

request - Servlet request

Returns:

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

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

findTerm

@GetMapping(path="/")
public SubjectAreaOMASAPIResponse findTerm(@RequestParam(value="searchCriteria",required=false)
                                                                 String searchCriteria,
                                                                 @RequestParam(value="asOfTime",required=false)
                                                                 Date asOfTime,
                                                                 @RequestParam(value="offset",required=false)
                                                                 Integer offset,
                                                                 @RequestParam(value="pageSize",required=false)
                                                                 Integer pageSize,
                                                                 @RequestParam(value="sequencingOrder",required=false)
                                                                 SequencingOrder sequencingOrder,
                                                                 @RequestParam(value="SequencingProperty",required=false)
                                                                 String sequencingProperty,
                                                                 javax.servlet.http.HttpServletRequest request)

Find Term

Parameters:

searchCriteria - String expression matching Term property values.

asOfTime - the terms returned as they were at this time. null indicates at the current time.

offset - the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

pageSize - the maximum number of elements that can be returned on this request. 0 means there is no limit to the page size

sequencingOrder - the sequencing order for the results.

sequencingProperty - the name of the property that should be used to sequence the results.

request - Servlet request

Returns:

A list of terms meeting the search Criteria

• 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.
• FunctionNotSupportedException Function not supported this indicates that a find was issued but the repository does not implement find functionality in some way.

getTermRelationships

@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse getTermRelationships(@PathVariable
                                                                                                 String guid,
                                                                                                 @RequestParam(value="asOfTime",required=false)
                                                                                                 Date asOfTime,
                                                                                                 @RequestParam(value="offset",required=false)
                                                                                                 Integer offset,
                                                                                                 @RequestParam(value="pageSize",required=false)
                                                                                                 Integer pageSize,
                                                                                                 @RequestParam(value="sequencingOrder",required=false)
                                                                                                 SequencingOrder sequencingOrder,
                                                                                                 @RequestParam(value="SequencingProperty",required=false)
                                                                                                 String sequencingProperty,
                                                                                                 javax.servlet.http.HttpServletRequest request)

updateTerm

@PutMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse updateTerm(@PathVariable
                                                                         String guid,
                                                                         @RequestBody
                                                                         Term term,
                                                                         @RequestParam(value="isReplace",required=false)
                                                                         Boolean isReplace,
                                                                         javax.servlet.http.HttpServletRequest request)

Update a Term

If the caller has chosen to incorporate the term name in their Term Terms or Categories qualified name, renaming the term will cause those qualified names to mismatch the Term name. If the caller has chosen to incorporate the term qualifiedName in their Term Terms or Categories qualified name, changing the qualified name of the term will cause those qualified names to mismatch the Term name. Status is not updated using this call.

Parameters:

guid - guid of the term to update

term - term to update

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

request - Servlet request

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

@DeleteMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse deleteTerm(@PathVariable
                                                                            String guid,
                                                                            @RequestParam(value="isPurge",required=false)
                                                                            Boolean isPurge,
                                                                            javax.servlet.http.HttpServletRequest request)

Delete a Term instance

The deletion of a term is only allowed if there is no term content (i.e. no terms or categories).

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:

guid - guid of the term to be deleted.

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

request - Servlet request

Returns:

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

restoreTerm

@PostMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse restoreTerm(@PathVariable
                                                                           String guid,
                                                                           javax.servlet.http.HttpServletRequest request)

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

Parameters:

guid - guid of the term to restore

request - Servlet request

Returns:

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