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

Class SubjectAreaCategoryRESTResource

java.lang.Object

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

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

@RestController
 @RequestMapping(value="/open-metadata/access-services/subject-area")
public class SubjectAreaCategoryRESTResource
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 category 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
SubjectAreaCategoryRESTResource() 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.category.Category suppliedCategory) Create a Category.
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	deleteCategory(String userid, String guid, Boolean isPurge) Delete a Category instance
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	getCategoryByGuid(String userid, String guid) Get a Category
org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse	updateCategory(String userid, String guid, org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category suppliedCategory, Boolean isReplace) Update a Category

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

SubjectAreaCategoryRESTResource

public SubjectAreaCategoryRESTResource()

Default constructor

Method Detail

createGlossary

@RequestMapping(method=POST,
                path="/users/{userid}/categories")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse createGlossary(@PathVariable
                                                                                                                                                                                            String userid,
                                                                                                                                                                                            @RequestBody
                                                                                                                                                                                            org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category suppliedCategory)

Create a Category. There is specialization of a Category that can also be created using this operation. To create this specialization, you should specify a nodeType other than Category in the supplied category.

Valid nodeTypes for this request are:

• SubjectArea to create a Category that represents a subject area
• Category to create a category that is not a subject area

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 GlossaryCategory concatinated with the the guid.

Failure to create the Categories classifications, link to its glossary or its icon, results in the create failing and the category being deleted

Parameters:

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

suppliedCategory - category to create

Returns:

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

getCategoryByGuid

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

Get a Category

Parameters:

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

guid - guid of the category to get

Returns:

response, when successful contains the category associated 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
• FunctionNotSupportedException Function not supported

updateCategory

@RequestMapping(method=PUT,
                path="/users/{userid}/categories/{guid}")
public org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse updateCategory(@PathVariable
                                                                                                                                                                                                  String userid,
                                                                                                                                                                                                  @PathVariable
                                                                                                                                                                                                  String guid,
                                                                                                                                                                                                  org.odpi.openmetadata.accessservices.subjectarea.properties.objects.category.Category suppliedCategory,
                                                                                                                                                                                                  @RequestParam(value="isReplace",required=false)
                                                                                                                                                                                                  Boolean isReplace)

Update a Category

Status is not updated using this call.

Parameters:

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

guid - guid of the category to update

suppliedCategory - category to be updated

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

deleteCategory

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

Delete a Category 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 category 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 category will not exist after the operation. when not successful the following Exceptions can occur

Parameters:

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

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