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

Class TermResource

java.lang.Object
org.odpi.openmetadata.accessservices.glossaryview.server.spring.TermResource
@RestController @Validated @RequestMapping("/servers/{serverName}/open-metadata/access-services/glossary-view/users/{userId}") public class TermResource extends Object
Spring Rest Controller defining 'GlossaryTerm' oriented endpoints

  • Constructor Summary

    Constructors
    Constructor
    Description
    TermResource()
    Called by Spring

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getAllTerms(String serverName, String userId, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract all terms definitions
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getAntonyms(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract antonyms
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getAssignedElements(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract assigned elements
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getAttributes(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract attributes
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getExternalGlossaryLinks(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract external glossary link definitions for the given term
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getIsA(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract "is a"
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getPreferredTerms(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract preferred terms
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getRelatedTerms(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract related terms
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getReplacementTerms(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract replacement terms
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getSubtypes(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract subtypes
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getSynonyms(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract synonyms
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getTerm(String serverName, String userId, @NotBlank String termGUID)
    Extract a term definition for the given GUID
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getTermsViaTermAnchorRelationships(String serverName, String userId, @NotBlank String glossaryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract term definitions for the given glossary GUID via the 'TermAnchor' type relationships
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getTermsViaTermCategorizationRelationships(String serverName, String userId, @NotBlank String categoryGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract term definitions for the given GUID via the 'TermCategorization' type relationships
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getTranslations(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract translations
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getTypes(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract types
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getUsedInContexts(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract "used in contexts"
    org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse
    getValidValues(String serverName, String userId, @NotBlank String termGUID, @PositiveOrZero Integer from, @PositiveOrZero @Max(1000L) Integer size)
    Extract valid values

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TermResource

      public TermResource()
      Called by Spring

  • Method Details

    • getAllTerms

      @GetMapping(path="/terms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAllTerms(@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 terms definitions
      Parameters:
      serverName - instance to call
      userId - calling user
      from - from
      size - size
      Returns:
      all terms

    • getTerm

      @GetMapping(path="/terms/{termGUID}") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTerm(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID)
      Extract a term definition for the given GUID
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - category GUID
      Returns:
      term

    • getTermsViaTermAnchorRelationships

      @GetMapping(path="/glossaries/{glossaryGUID}/terms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTermsViaTermAnchorRelationships(@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 term definitions for the given glossary GUID via the 'TermAnchor' type relationships
      Parameters:
      serverName - instance to call
      userId - calling user
      glossaryGUID - glossary GUID
      from - from
      size - size
      Returns:
      terms

    • getTermsViaTermCategorizationRelationships

      @GetMapping(path="/categories/{categoryGUID}/terms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTermsViaTermCategorizationRelationships(@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 term definitions for the given GUID via the 'TermCategorization' type relationships
      Parameters:
      serverName - instance to call
      userId - calling user
      categoryGUID - category GUID
      from - from
      size - size
      Returns:
      subcategories

    • getExternalGlossaryLinks

      @GetMapping(path="/terms/{termGUID}/external-glossary-links") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getExternalGlossaryLinks(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @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 term
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      external glossary links

    • getRelatedTerms

      @GetMapping(path="/terms/{termGUID}/see-also") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getRelatedTerms(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract related terms
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      related terms

    • getSynonyms

      @GetMapping(path="/terms/{termGUID}/synonyms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getSynonyms(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract synonyms
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      synonyms

    • getAntonyms

      @GetMapping(path="/terms/{termGUID}/antonyms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAntonyms(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract antonyms
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      antonyms

    • getPreferredTerms

      @GetMapping(path="/terms/{termGUID}/preferred-terms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getPreferredTerms(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract preferred terms
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      preferred terms

    • getReplacementTerms

      @GetMapping(path="/terms/{termGUID}/replacement-terms") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getReplacementTerms(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract replacement terms
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      replacement terms

    • getTranslations

      @GetMapping(path="/terms/{termGUID}/translations") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTranslations(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract translations
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      translations

    • getIsA

      @GetMapping(path="/terms/{termGUID}/is-a") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getIsA(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract "is a"
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      "is a"

    • getValidValues

      @GetMapping(path="/terms/{termGUID}/valid-values") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getValidValues(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract valid values
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      valid values

    • getUsedInContexts

      @GetMapping(path="/terms/{termGUID}/used-in-contexts") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getUsedInContexts(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract "used in contexts"
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      "used in contexts"

    • getAssignedElements

      @GetMapping(path="/terms/{termGUID}/assigned-elements") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAssignedElements(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract assigned elements
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      assigned elements

    • getAttributes

      @GetMapping(path="/terms/{termGUID}/attributes") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getAttributes(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract attributes
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      attributes

    • getSubtypes

      @GetMapping(path="/terms/{termGUID}/subtypes") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getSubtypes(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract subtypes
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      subtypes

    • getTypes

      @GetMapping(path="/terms/{termGUID}/types") public org.odpi.openmetadata.accessservices.glossaryview.rest.GlossaryViewEntityDetailResponse getTypes(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID, @RequestParam(name="from",defaultValue="0") @PositiveOrZero @PositiveOrZero Integer from, @RequestParam(name="size",defaultValue="100") @PositiveOrZero @Max(1000L) @PositiveOrZero @Max(1000L) Integer size)
      Extract types
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      types