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}") @Deprecated public class TermResource extends Object
Deprecated.
Spring Rest Controller defining 'GlossaryTerm' oriented endpoints

  • Constructor Details

    • TermResource

      public TermResource()
      Deprecated.
      Called by Spring

  • Method Details

    • getAllTerms

      @GetMapping(path="/terms") public 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)
      Deprecated.
      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 GlossaryViewEntityDetailResponse getTerm(@PathVariable("serverName") String serverName, @PathVariable("userId") String userId, @PathVariable("termGUID") @NotBlank @NotBlank String termGUID)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      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 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)
      Deprecated.
      Extract types
      Parameters:
      serverName - instance to call
      userId - calling user
      termGUID - term GUID
      from - from
      size - size
      Returns:
      types