Function getGlossaryTerms

Parameters

• id: string

  The glossary id.

• query: {
      countTotal?: boolean;
      filter?: string;
      limit?: number;
      next?: string;
      prev?: string;
      sort?:
          | "status"
          | "name"
          | "+status"
          | "-status"
          | "description"
          | "+description"
          | "-description"
          | "-name"
          | "+name"
          | "updated"
          | "abbreviation"
          | "+abbreviation"
          | "-abbreviation"
          | "+updated"
          | "-updated";
  }

  an object with query parameters

  • OptionalcountTotal?: boolean

    Optional parameter to request total count for query

  • Optionalfilter?: string

    Optional SCIM filter to be used to filter terms Usable fields are

    • id
    • name
    • relatedInformation
    • description
    • abbreviation
    • tags
    • stewards
    • status
    • categories

  • Optionallimit?: number

    The number of terms to get.

  • Optionalnext?: string

    Optional parameter to request the next page.

  • Optionalprev?: string

    Optional parameter to request the previous page.

  • Optionalsort?:
        | "status"
        | "name"
        | "+status"
        | "-status"
        | "description"
        | "+description"
        | "-description"
        | "-name"
        | "+name"
        | "updated"
        | "abbreviation"
        | "+abbreviation"
        | "-abbreviation"
        | "+updated"
        | "-updated"

    Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.

• Optionaloptions: ApiCallOptions