org.odpi.openmetadata.viewservices.glossaryauthor.server

Class GlossaryAuthorViewCategoryRESTResource

java.lang.Object

org.odpi.openmetadata.viewservices.glossaryauthor.server.GlossaryAuthorViewCategoryRESTResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/view-services/glossary-author/users/{userId}/categories")
public class GlossaryAuthorViewCategoryRESTResource
extends Object

The GlossaryAuthorRESTServicesInstance provides the org.odpi.openmetadata.viewervices.glossaryauthor.server implementation of the Glossary Author Open Metadata View Service (OMVS) for categories. This interface provides category authoring interfaces for subject area experts.

Constructor Summary

Constructors

Constructor and Description
GlossaryAuthorViewCategoryRESTResource() Default constructor

Method Summary

Modifier and Type	Method and Description
SubjectAreaOMASAPIResponse<Category>	createCategory(String serverName, String userId, Category suppliedCategory) Create a Category.
SubjectAreaOMASAPIResponse<Category>	deleteCategory(String serverName, String userId, String guid, Boolean isPurge) Delete a Category instance
SubjectAreaOMASAPIResponse<Category>	findCategory(String serverName, String userId, String searchCriteria, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Find Category
SubjectAreaOMASAPIResponse<Category>	getCategory(String serverName, String userId, String guid) Get a category.
SubjectAreaOMASAPIResponse<Line>	getCategoryRelationships(String serverName, String userId, String guid, Date asOfTime, Integer offset, Integer pageSize, SequencingOrder sequencingOrder, String sequencingProperty) Get Category relationships.
SubjectAreaOMASAPIResponse<Category>	restoreCategory(String serverName, String userId, String guid) Restore a Category
SubjectAreaOMASAPIResponse<Category>	updateCategory(String serverName, String userId, String guid, Category suppliedCategory, Boolean isReplace) Update a Category

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryAuthorViewCategoryRESTResource

public GlossaryAuthorViewCategoryRESTResource()

Default constructor

Method Detail

createCategory

@PostMapping
public SubjectAreaOMASAPIResponse<Category> createCategory(@PathVariable
                                                                        String serverName,
                                                                        @PathVariable
                                                                        String userId,
                                                                        @RequestBody
                                                                        Category suppliedCategory)

Create a Category.

Categories with the same name can be confusing. Best practise is to create categories that have unique names. This Create call does not police that Category names are unique. So it is possible to create categories with the same name as each other.

Parameters:

serverName - name of the local server.

userId - userid

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

getCategory

@GetMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Category> getCategory(@PathVariable
                                                                                    String serverName,
                                                                                    @PathVariable
                                                                                    String userId,
                                                                                    @PathVariable
                                                                                    String guid)

Get a category.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the category to get

Returns:

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

findCategory

@GetMapping
public SubjectAreaOMASAPIResponse<Category> findCategory(@PathVariable
                                                                     String serverName,
                                                                     @PathVariable
                                                                     String userId,
                                                                     @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)

Find Category

Parameters:

serverName - local UI server name

userId - userid

searchCriteria - String expression matching Category property values .

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

sequencingOrder - the sequencing order for the results.

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

Returns:

A list of categories meeting the search Criteria

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

getCategoryRelationships

@GetMapping(path="/{guid}/relationships")
public SubjectAreaOMASAPIResponse<Line> getCategoryRelationships(@PathVariable
                                                                                                           String serverName,
                                                                                                           @PathVariable
                                                                                                           String userId,
                                                                                                           @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)

Get Category relationships. The server has a maximum page size defined, the number of relationships returned is limited by that maximum page size.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the category to get

asOfTime - the relationships returned as they were at this time. null indicates at the current time. If specified, the date is in milliseconds since 1970-01-01 00:00:00.

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.

sequencingOrder - the sequencing order for the results.

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

Returns:

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

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

updateCategory

@PutMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Category> updateCategory(@PathVariable
                                                                                       String serverName,
                                                                                       @PathVariable
                                                                                       String userId,
                                                                                       @PathVariable
                                                                                       String guid,
                                                                                       @RequestBody
                                                                                       Category suppliedCategory,
                                                                                       @RequestParam(value="isReplace",required=false,defaultValue="false")
                                                                                       Boolean isReplace)

Update a Category

Status is not updated using this call.

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the category to update

suppliedCategory - category to update

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 category when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

deleteCategory

@DeleteMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Category> deleteCategory(@PathVariable
                                                                                          String serverName,
                                                                                          @PathVariable
                                                                                          String userId,
                                                                                          @PathVariable
                                                                                          String guid,
                                                                                          @RequestParam(value="isPurge",required=false,defaultValue="false")
                                                                                          Boolean isPurge)

Delete a Category instance

The deletion of a category is only allowed if there is no category content (i.e. no categories 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 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:

serverName - local UI server name

userId - userid

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

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.

restoreCategory

@PostMapping(path="/{guid}")
public SubjectAreaOMASAPIResponse<Category> restoreCategory(@PathVariable
                                                                                         String serverName,
                                                                                         @PathVariable
                                                                                         String userId,
                                                                                         @PathVariable
                                                                                         String guid)

Restore a Category

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

Parameters:

serverName - local UI server name

userId - userid

guid - guid of the category to restore

Returns:

response which when successful contains the restored category when not successful the following Exception responses can occur

• UserNotAuthorizedException the requesting user is not authorized to issue this request.
• InvalidParameterException one of the parameters is null or invalid.
• PropertyServerException Property server exception.