Package org.odpi.openmetadata.accessservices.glossaryview.server.spring

Class GlossaryResource

java.lang.Object

org.odpi.openmetadata.accessservices.glossaryview.server.spring.GlossaryResource

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

Spring Rest Controller defining 'Glossary' oriented endpoints

Constructor Summary

Constructors

Constructor	Description
GlossaryResource()	Called by Spring

Method Summary

Modifier and Type	Method	Description
GlossaryViewEntityDetailResponse	getAllGlossaries(String serverName, String userId, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)	Extract all glossary definitions
GlossaryViewEntityDetailResponse	getCategoryHomeGlossary(String serverName, String userId, @NotBlank String categoryGUID)	Extract a category's home glossary
GlossaryViewEntityDetailResponse	getExternalGlossaryLinks(String serverName, String userId, @NotBlank String glossaryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)	Extract the external glossary link definitions
GlossaryViewEntityDetailResponse	getGlossary(String serverName, String userId, @NotBlank String glossaryGUID)	Extract a glossary definition
GlossaryViewEntityDetailResponse	getTermHomeGlossary(String serverName, String userId, @NotBlank String termGUID)	Extract a term's home glossary

Methods inherited from class java.lang.Object

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

Constructor Detail

GlossaryResource

public GlossaryResource()

Called by Spring

Method Detail

getAllGlossaries

@GetMapping(path="/glossaries")
public GlossaryViewEntityDetailResponse getAllGlossaries(@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 glossary definitions

Parameters:

serverName - instance to call

userId - calling user

from - from

size - size

Returns:

glossaries

getGlossary

@GetMapping(path="/glossaries/{glossaryGUID}")
public GlossaryViewEntityDetailResponse getGlossary(@PathVariable("serverName")
                                                    String serverName,
                                                    @PathVariable("userId")
                                                    String userId,
                                                    @PathVariable("glossaryGUID") @NotBlank
                                                    @NotBlank String glossaryGUID)

Extract a glossary definition

Parameters:

serverName - instance to call

userId - calling user

glossaryGUID - glossary GUID

Returns:

a glossary

getTermHomeGlossary

@GetMapping(path="/terms/{termGUID}/home-glossary")
public GlossaryViewEntityDetailResponse getTermHomeGlossary(@PathVariable("serverName")
                                                            String serverName,
                                                            @PathVariable("userId")
                                                            String userId,
                                                            @PathVariable("termGUID") @NotBlank
                                                            @NotBlank String termGUID)

Extract a term's home glossary

Parameters:

serverName - instance to call

userId - calling user

termGUID - term GUID

Returns:

glossaries

getCategoryHomeGlossary

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

Extract a category's home glossary

Parameters:

serverName - instance to call

userId - calling user

categoryGUID - category GUID

Returns:

glossaries

getExternalGlossaryLinks

@GetMapping(path="/glossaries/{glossaryGUID}/external-glossary-links")
public GlossaryViewEntityDetailResponse getExternalGlossaryLinks(@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 the external glossary link definitions

Parameters:

serverName - instance to call

userId - calling user

glossaryGUID - glossary GUID

from - from

size - size

Returns:

external glossary links