Package org.odpi.openmetadata.viewservices.glossarybrowser.server.spring

Class GlossaryBrowserResource

java.lang.Object
org.odpi.openmetadata.viewservices.glossarybrowser.server.spring.GlossaryBrowserResource
@RestController @RequestMapping("/servers/{serverName}/api/open-metadata/glossary-browser") public class GlossaryBrowserResource extends Object
The GlossaryBrowserResource provides the Spring API endpoints of the Glossary Browser Open Metadata View Service (OMVS). This interface provides a service for Egeria UIs.

  • Constructor Details

    • GlossaryBrowserResource

      public GlossaryBrowserResource()
      Default constructor

  • Method Details

    • getGlossaryTermStatuses

      @GetMapping(path="/glossaries/terms/status-list") public GlossaryTermStatusListResponse getGlossaryTermStatuses(@PathVariable String serverName)
      Return the list of glossary term status enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • getGlossaryTermRelationshipStatuses

      @GetMapping(path="/glossaries/terms/relationships/status-list") public GlossaryTermRelationshipStatusListResponse getGlossaryTermRelationshipStatuses(@PathVariable String serverName)
      Return the list of glossary term relationship status enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • getGlossaryTermActivityTypes

      @GetMapping(path="/glossaries/terms/activity-types") public GlossaryTermActivityTypeListResponse getGlossaryTermActivityTypes(@PathVariable String serverName)
      Return the list of glossary term activity type enum values.
      Parameters:
      serverName - name of the server to route the request to
      Returns:
      list of enum values

    • findGlossaries

      @PostMapping(path="/glossaries/by-search-string") public OpenMetadataRootElementsResponse findGlossaries(@PathVariable String serverName, @RequestBody SearchStringRequestBody requestBody)
      Retrieve the list of glossary metadata elements that contain the search string.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - string to find in the properties
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossariesByName

      @PostMapping(path="/glossaries/by-name") public OpenMetadataRootElementsResponse getGlossariesByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the list of glossary metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - name to search for
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossaryByGUID

      @PostMapping(path="/glossaries/{glossaryGUID}/retrieve") public OpenMetadataRootElementResponse getGlossaryByGUID(@PathVariable String serverName, @PathVariable String glossaryGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve the glossary metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryGUID - unique identifier of the requested metadata element
      requestBody - asset manager identifiers
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossaryForTerm

      @PostMapping(path="/glossaries/for-term/{glossaryTermGUID}/retrieve") public OpenMetadataRootElementResponse getGlossaryForTerm(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve the glossary metadata element for the requested term.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the requested metadata element
      requestBody - asset manager identifiers
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findGlossaryTerms

      @PostMapping(path="/glossaries/terms/by-search-string") public OpenMetadataRootElementsResponse findGlossaryTerms(@PathVariable String serverName, @RequestBody(required=false) SearchStringRequestBody requestBody)
      Retrieve the list of glossary term metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - asset manager identifiers and search string
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossaryTermsByName

      @PostMapping(path="/glossaries/terms/by-name") public OpenMetadataRootElementsResponse getGlossaryTermsByName(@PathVariable String serverName, @RequestBody(required=false) FilterRequestBody requestBody)
      Retrieve the list of glossary term metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      requestBody - asset manager identifiers and name
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getGlossaryTermByGUID

      @PostMapping(path="/glossaries/terms/{glossaryTermGUID}/retrieve") public OpenMetadataRootElementResponse getGlossaryTermByGUID(@PathVariable String serverName, @PathVariable String glossaryTermGUID, @RequestBody(required=false) GetRequestBody requestBody)
      Retrieve the glossary term metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      glossaryTermGUID - unique identifier of the requested metadata element
      requestBody - asset manager identifiers
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)