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

Class SubjectAreaGlossaryRESTResource

java.lang.Object

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

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

@RestController
 @RequestMapping(value="/open-metadata/access-services/subject-area")
public class SubjectAreaGlossaryRESTResource
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 glossary 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
SubjectAreaGlossaryRESTResource() Default constructor

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	createGlossary(String userid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary suppliedGlossary) Create a Glossary.
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	deleteGlossary(String userid, String guid, Boolean isPurge) Delete a Glossary instance The deletion of a glossary is only allowed if there is no glossary content (i.e.
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	getGlossary(String userid, String id, Boolean idIsName) Get a glossary.
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	updateGlossary(String userid, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary, Boolean isReplace) 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.

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

SubjectAreaGlossaryRESTResource

public SubjectAreaGlossaryRESTResource()

Default constructor

Method Detail

createGlossary

@RequestMapping(method=POST,
                path="/users/{userid}/glossaries")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createGlossary(@PathVariable
                                                                                                                                                                                            String userid,
                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                            org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary suppliedGlossary)

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:

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

suppliedGlossary - Glossary to create

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
• FunctionNotSupportedException Function not supported
• StatusNotSupportedException A status value is not supported

getGlossary

@RequestMapping(method=GET,
                path="/users/{userid}/glossaries/{id}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse getGlossary(@PathVariable
                                                                                                                                                                                             String userid,
                                                                                                                                                                                             @PathVariable
                                                                                                                                                                                             String id,
                                                                                                                                                                                             @RequestParam(value="idIsName",required=false)
                                                                                                                                                                                             Boolean idIsName)

Get a glossary.

Parameters:

userid - userid under which the request is performed

id - id of the glossary to get, this can be a name or a guid depending on the

idIsName - When set this indicates that the id is a name

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

updateGlossary

@RequestMapping(method=PUT,
                path="/users/{userid}/glossaries/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateGlossary(@PathVariable
                                                                                                                                                                                                  String userid,
                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                  String guid,
                                                                                                                                                                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.objects.glossary.Glossary glossary,
                                                                                                                                                                                                  @RequestParam(value="isReplace",required=false)
                                                                                                                                                                                                  Boolean isReplace)

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:

userid - userid under which the request is performed

guid - guid of the glossary to update

glossary - glossary to be updated

isReplace - flag to indicate that this update is a replace. When not set only the supplied (non null) fields are updated. * @return 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

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

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:

userid - userid under which the request is performed

guid - guid of the glossary to be deleted.

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

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