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

Class SubjectAreaGlossaryController

java.lang.Object

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

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

@RestController
 @RequestMapping(value="/api/subject-area/glossaries")
 @DependsOn(value="securityConfig")
public class SubjectAreaGlossaryController
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 glossary authoring interfaces for subject area experts.

Constructor Summary

Constructors

Constructor and Description
SubjectAreaGlossaryController(SubjectArea subjectArea) Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse	createGlossary(Glossary suppliedGlossary, javax.servlet.http.HttpServletRequest request) Create a Glossary.
SubjectAreaOMASAPIResponse	deleteGlossary(String guid, Boolean isPurge, javax.servlet.http.HttpServletRequest request) Delete a Glossary instance
SubjectAreaOMASAPIResponse	findGlossary(String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request) Find Glossary
SubjectAreaOMASAPIResponse	getGlossary(String guid, javax.servlet.http.HttpServletRequest request) Get a glossary.
SubjectAreaOMASAPIResponse	getGlossaryRelationships(String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty, javax.servlet.http.HttpServletRequest request)
SubjectAreaOMASAPIResponse	restoreGlossary(String guid, javax.servlet.http.HttpServletRequest request) Restore a Glossary Restore allows the deleted Glossary to be made active again.
SubjectAreaOMASAPIResponse	updateGlossary(String guid, Glossary glossary, Boolean isReplace, javax.servlet.http.HttpServletRequest request) Update a Glossary

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

SubjectAreaGlossaryController

public SubjectAreaGlossaryController(SubjectArea subjectArea)

Default constructor

Parameters:

subjectArea - main client object for the Subject Area OMAS

Method Detail

createGlossary

@PostMapping
public SubjectAreaOMASAPIResponse createGlossary(@RequestBody
                                                              Glossary suppliedGlossary,
                                                              javax.servlet.http.HttpServletRequest request)

Create a Glossary. There are specializations of glossaries that can also be created using this operation. To create a specialization, you should specify a nodeType other than Glossary in the supplied glossary.

Valid nodeTypes for this request are:

• Taxonomy to create a Taxonomy
• CanonicalGlossary to create a canonical glossary
• TaxonomyAndCanonicalGlossary to create a glossary that is both a taxonomy and a canonical glosary
• Glossary to create a glossary that is not a taxonomy or a canonical glossary

Parameters:

suppliedGlossary - Glossary to create

request - servlet request

Returns:

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

getGlossary

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

Get a glossary.

Parameters:

guid - guid of the glossary to get

request - servlet request

Returns:

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

findGlossary

@GetMapping
public SubjectAreaOMASAPIResponse findGlossary(@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 Glossary

Parameters:

searchCriteria - String expression matching Glossary property values .

asOfTime - the glossaries 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 glossaries 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.

getGlossaryRelationships

@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse getGlossaryRelationships(@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)

updateGlossary

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

Update a Glossary

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

Parameters:

guid - guid of the glossary to update

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

deleteGlossary

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

Delete a Glossary instance

The deletion of a glossary is only allowed if there is no glossary 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 glossary 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 glossary will not exist after the operation. when not successful the following Exceptions can occur

Parameters:

guid - guid of the glossary 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 glossary was not deleted.
• GUIDNotPurgedException a hard delete was issued but the glossary was not purged

restoreGlossary

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

Restore a Glossary Restore allows the deleted Glossary 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 glossary to restore

request - servlet request

Returns:

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