java.lang.Object
- org.odpi.openmetadata.accessservices.glossaryview.server.spring.CategoryResource

@RestController
@Validated
@RequestMapping("/servers/{serverName}/open-metadata/access-services/glossary-view/users/{userId}")
public class CategoryResource
extends Object

Spring Rest Controller defining 'GlossaryCategory' oriented endpoints

Constructor Summary

Constructors
Constructor Description

CategoryResource()
Called by Spring

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`GlossaryViewEntityDetailResponse`	`getAllCategories(String serverName, String userId, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)`	Extract all categories
`GlossaryViewEntityDetailResponse`	`getCategoriesViaCategoryAnchorRelationships(String serverName, String userId, @NotBlank String glossaryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)`	Extract category definitions for the given glossary GUID via the 'CategoryAnchor' type relationships
`GlossaryViewEntityDetailResponse`	`getCategory(String serverName, String userId, @NotBlank String categoryGUID)`	Extract the category definition for the given GUID
`GlossaryViewEntityDetailResponse`	`getExternalGlossaryLinks(String serverName, String userId, @NotBlank String categoryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)`	Extract external glossary link definitions for the given category
`GlossaryViewEntityDetailResponse`	`getSubcategories(String serverName, String userId, @NotBlank String categoryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)`	Extract subcategory definitions for the given GUID

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- CategoryResource
```
public CategoryResource()
```
  Called by Spring

Method Detail

getAllCategories

@GetMapping(path="/categories")
public GlossaryViewEntityDetailResponse getAllCategories(@PathVariable("serverName")
                                                         String serverName,
                                                         @PathVariable("userId")
                                                         String userId,
                                                         @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                         @PositiveOrZero Integer from,
                                                         @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L)
                                                         @PositiveOrZero @Max(1000L) Integer size)

Extract all categories

Parameters:: serverName - instance to call; userId - calling user; from - from; size - size
Returns:: categories

getCategory

@GetMapping(path="/categories/{categoryGUID}")
public GlossaryViewEntityDetailResponse getCategory(@PathVariable("serverName")
                                                    String serverName,
                                                    @PathVariable("userId")
                                                    String userId,
                                                    @PathVariable("categoryGUID") @NotBlank
                                                    @NotBlank String categoryGUID)

Extract the category definition for the given GUID

Parameters:: serverName - instance to call; userId - calling user; categoryGUID - category GUID
Returns:: a category

getCategoriesViaCategoryAnchorRelationships

@GetMapping(path="/glossaries/{glossaryGUID}/categories")
public GlossaryViewEntityDetailResponse getCategoriesViaCategoryAnchorRelationships(@PathVariable("serverName")
                                                                                    String serverName,
                                                                                    @PathVariable("userId")
                                                                                    String userId,
                                                                                    @PathVariable("glossaryGUID") @NotBlank
                                                                                    @NotBlank String glossaryGUID,
                                                                                    @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                                                    @PositiveOrZero Integer from,
                                                                                    @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L)
                                                                                    @PositiveOrZero @Max(1000L) Integer size)

Extract category definitions for the given glossary GUID via the 'CategoryAnchor' type relationships

Parameters:: serverName - instance to call; userId - calling user; glossaryGUID - glossary GUID; from - from; size - size
Returns:: categories

getSubcategories

@GetMapping(path="/categories/{categoryGUID}/subcategories")
public GlossaryViewEntityDetailResponse getSubcategories(@PathVariable("serverName")
                                                         String serverName,
                                                         @PathVariable("userId")
                                                         String userId,
                                                         @PathVariable("categoryGUID") @NotBlank
                                                         @NotBlank String categoryGUID,
                                                         @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                         @PositiveOrZero Integer from,
                                                         @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L)
                                                         @PositiveOrZero @Max(1000L) Integer size)

Extract subcategory definitions for the given GUID

Parameters:: serverName - instance to call; userId - calling user; categoryGUID - category GUID; from - from; size - size
Returns:: subcategories

getExternalGlossaryLinks

@GetMapping(path="/categories/{categoryGUID}/external-glossary-links")
public GlossaryViewEntityDetailResponse getExternalGlossaryLinks(@PathVariable("serverName")
                                                                 String serverName,
                                                                 @PathVariable("userId")
                                                                 String userId,
                                                                 @PathVariable("categoryGUID") @NotBlank
                                                                 @NotBlank String categoryGUID,
                                                                 @RequestParam(name="from",defaultValue="0") @PositiveOrZero
                                                                 @PositiveOrZero Integer from,
                                                                 @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L)
                                                                 @PositiveOrZero @Max(1000L) Integer size)

Extract external glossary link definitions for the given category

Parameters:: serverName - instance to call; userId - calling user; categoryGUID - category GUID; from - from; size - size
Returns:: external glossary links

Class CategoryResource

Constructor Summary