Interface GlossariesAPI

interface GlossariesAPI {
    changeGlossaryTermStatus: (
        id: string,
        termId: string,
        query: { status: "draft" | "verified" | "deprecated" },
        options?: ApiCallOptions,
    ) => Promise<ChangeGlossaryTermStatusHttpResponse>;
    clearCache: () => void;
    createGlossary: (
        body: CreateGlossary,
        options?: ApiCallOptions,
    ) => Promise<CreateGlossaryHttpResponse>;
    createGlossaryCategory: (
        id: string,
        body: CreateCategory,
        options?: ApiCallOptions,
    ) => Promise<CreateGlossaryCategoryHttpResponse>;
    createGlossaryTerm: (
        id: string,
        body: CreateTerm,
        options?: ApiCallOptions,
    ) => Promise<CreateGlossaryTermHttpResponse>;
    createGlossaryTermLink: (
        id: string,
        termId: string,
        body: TermCreateLinksTo,
        options?: ApiCallOptions,
    ) => Promise<CreateGlossaryTermLinkHttpResponse>;
    deleteGlossary: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteGlossaryHttpResponse>;
    deleteGlossaryCategory: (
        id: string,
        categoryId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteGlossaryCategoryHttpResponse>;
    deleteGlossaryTerm: (
        id: string,
        termId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteGlossaryTermHttpResponse>;
    exportGlossary: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<ExportGlossaryHttpResponse>;
    getGlossaries: (
        query: {
            countTotal?: boolean;
            limit?: number;
            next?: string;
            prev?: string;
            sort?:
                | "name"
                | "description"
                | "+description"
                | "-description"
                | "-name"
                | "+name";
        },
        options?: ApiCallOptions,
    ) => Promise<GetGlossariesHttpResponse>;
    getGlossary: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryHttpResponse>;
    getGlossaryCategories: (
        id: string,
        query: {
            countTotal?: boolean;
            limit?: number;
            next?: string;
            prev?: string;
            sort?:
                | "update"
                | "name"
                | "description"
                | "+description"
                | "-description"
                | "-name"
                | "+name"
                | "+update"
                | "-update";
        },
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryCategoriesHttpResponse>;
    getGlossaryCategory: (
        id: string,
        categoryId: string,
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryCategoryHttpResponse>;
    getGlossaryTerm: (
        id: string,
        termId: string,
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryTermHttpResponse>;
    getGlossaryTermLinks: (
        id: string,
        termId: string,
        query: {
            countTotal?: boolean;
            filter?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?:
                | "type"
                | "created"
                | "+created"
                | "-created"
                | "+type"
                | "-type"
                | "subtype"
                | "+subtype"
                | "-subtype";
        },
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryTermLinksHttpResponse>;
    getGlossaryTermRevisions: (
        id: string,
        termId: string,
        query: {
            countTotal?: boolean;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: "update" | "+update" | "-update";
        },
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryTermRevisionsHttpResponse>;
    getGlossaryTerms: (
        id: string,
        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";
        },
        options?: ApiCallOptions,
    ) => Promise<GetGlossaryTermsHttpResponse>;
    importGlossary: (
        query: {
            importerAsFallbackSteward?: boolean;
            lookupUserOnEmail?: boolean;
            spaceId?: string;
        },
        body: QlikGlossary,
        options?: ApiCallOptions,
    ) => Promise<ImportGlossaryHttpResponse>;
    patchGlossary: (
        id: string,
        body: JSONPatchArray,
        options?: ApiCallOptions,
    ) => Promise<PatchGlossaryHttpResponse>;
    patchGlossaryCategory: (
        id: string,
        categoryId: string,
        body: JSONPatchArray,
        options?: ApiCallOptions,
    ) => Promise<PatchGlossaryCategoryHttpResponse>;
    patchGlossaryTerm: (
        id: string,
        termId: string,
        body: JSONPatchArray,
        options?: ApiCallOptions,
    ) => Promise<PatchGlossaryTermHttpResponse>;
    updateGlossary: (
        id: string,
        body: CreateGlossary,
        options?: ApiCallOptions,
    ) => Promise<UpdateGlossaryHttpResponse>;
    updateGlossaryCategory: (
        id: string,
        categoryId: string,
        body: CreateCategory,
        options?: ApiCallOptions,
    ) => Promise<UpdateGlossaryCategoryHttpResponse>;
    updateGlossaryTerm: (
        id: string,
        termId: string,
        body: CreateTerm,
        options?: ApiCallOptions,
    ) => Promise<UpdateGlossaryTermHttpResponse>;
}
Index

Properties

changeGlossaryTermStatus clearCache createGlossary createGlossaryCategory createGlossaryTerm createGlossaryTermLink deleteGlossary deleteGlossaryCategory deleteGlossaryTerm exportGlossary getGlossaries getGlossary getGlossaryCategories getGlossaryCategory getGlossaryTerm getGlossaryTermLinks getGlossaryTermRevisions getGlossaryTerms importGlossary patchGlossary patchGlossaryCategory patchGlossaryTerm updateGlossary updateGlossaryCategory updateGlossaryTerm

Properties

changeGlossaryTermStatus: (
    id: string,
    termId: string,
    query: { status: "draft" | "verified" | "deprecated" },
    options?: ApiCallOptions,
) => Promise<ChangeGlossaryTermStatusHttpResponse>

Changes the status of the term. Only a steward can verify a term. Once the term is verified only a steward can modify the term.

Type declaration

    • (
          id: string,
          termId: string,
          query: { status: "draft" | "verified" | "deprecated" },
          options?: ApiCallOptions,
      ): Promise<ChangeGlossaryTermStatusHttpResponse>

    • Changes the status of the term. Only a steward can verify a term. Once the term is verified only a steward can modify the term.

      Parameters

      • id: string

        The glossary id.

      • termId: string

        The term id.

      • query: { status: "draft" | "verified" | "deprecated" }

        an object with query parameters

        • status: "draft" | "verified" | "deprecated"

          The status to update to.

      • Optionaloptions: ApiCallOptions

      Returns Promise<ChangeGlossaryTermStatusHttpResponse>

      ChangeGlossaryTermStatusHttpError

The glossary id.

The term id.

an object with query parameters

ChangeGlossaryTermStatusHttpError

clearCache: () => void

Clears the cache for glossaries api requests.

Type declaration

    • (): void

    • Clears the cache for glossaries api requests.

      Returns void

createGlossary: (
    body: CreateGlossary,
    options?: ApiCallOptions,
) => Promise<CreateGlossaryHttpResponse>

Creates a new glossary. Only a steward can create a glossary.

Type declaration

Param: body

an object with the body content

CreateGlossaryHttpError

createGlossaryCategory: (
    id: string,
    body: CreateCategory,
    options?: ApiCallOptions,
) => Promise<CreateGlossaryCategoryHttpResponse>

Creates a new category.

Type declaration

The glossary id.

Param: body

an object with the body content

CreateGlossaryCategoryHttpError

createGlossaryTerm: (
    id: string,
    body: CreateTerm,
    options?: ApiCallOptions,
) => Promise<CreateGlossaryTermHttpResponse>

Creates a new term.

Type declaration

The glossary id.

Param: body

an object with the body content

CreateGlossaryTermHttpError

createGlossaryTermLink: (
    id: string,
    termId: string,
    body: TermCreateLinksTo,
    options?: ApiCallOptions,
) => Promise<CreateGlossaryTermLinkHttpResponse>

Creates a new link to a term.

Type declaration

The glossary id.

The term id.

Param: body

an object with the body content

CreateGlossaryTermLinkHttpError

deleteGlossary: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteGlossaryHttpResponse>

Deletes a glossary and all of its terms.

Type declaration

The id of the glossary to delete.

DeleteGlossaryHttpError

deleteGlossaryCategory: (
    id: string,
    categoryId: string,
    options?: ApiCallOptions,
) => Promise<DeleteGlossaryCategoryHttpResponse>

Deletes a category.

Type declaration

The id of the glossary.

The id for the category to delete. All subcategories are also deleted

DeleteGlossaryCategoryHttpError

deleteGlossaryTerm: (
    id: string,
    termId: string,
    options?: ApiCallOptions,
) => Promise<DeleteGlossaryTermHttpResponse>

Deletes a term.

Type declaration

The glossary id.

The term id.

DeleteGlossaryTermHttpError

exportGlossary: (
    id: string,
    options?: ApiCallOptions,
) => Promise<ExportGlossaryHttpResponse>

Exports a glossary.

Type declaration

The glossary id.

ExportGlossaryHttpError

getGlossaries: (
    query: {
        countTotal?: boolean;
        limit?: number;
        next?: string;
        prev?: string;
        sort?:
            | "name"
            | "description"
            | "+description"
            | "-description"
            | "-name"
            | "+name";
    },
    options?: ApiCallOptions,
) => Promise<GetGlossariesHttpResponse>

Returns all glossaries.

Type declaration

    • (
          query: {
              countTotal?: boolean;
              limit?: number;
              next?: string;
              prev?: string;
              sort?:
                  | "name"
                  | "description"
                  | "+description"
                  | "-description"
                  | "-name"
                  | "+name";
          },
          options?: ApiCallOptions,
      ): Promise<GetGlossariesHttpResponse>

    • Returns all glossaries.

      Parameters

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

        an object with query parameters

        • OptionalcountTotal?: boolean

          Optional parameter to request total count for query

        • Optionallimit?: number

          The number of glossaries to get.

        • Optionalnext?: string

          Optional parameter to request the next page.

        • Optionalprev?: string

          Optional parameter to request the previous page.

        • Optionalsort?: "name" | "description" | "+description" | "-description" | "-name" | "+name"

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

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetGlossariesHttpResponse>

      GetGlossariesHttpError

an object with query parameters

GetGlossariesHttpError

getGlossary: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetGlossaryHttpResponse>

Retrieves a glossary.

Type declaration

The id of the glossary to retrieve.

GetGlossaryHttpError

getGlossaryCategories: (
    id: string,
    query: {
        countTotal?: boolean;
        limit?: number;
        next?: string;
        prev?: string;
        sort?:
            | "update"
            | "name"
            | "description"
            | "+description"
            | "-description"
            | "-name"
            | "+name"
            | "+update"
            | "-update";
    },
    options?: ApiCallOptions,
) => Promise<GetGlossaryCategoriesHttpResponse>

Returns a list of categories for a glossary.

Type declaration

    • (
          id: string,
          query: {
              countTotal?: boolean;
              limit?: number;
              next?: string;
              prev?: string;
              sort?:
                  | "update"
                  | "name"
                  | "description"
                  | "+description"
                  | "-description"
                  | "-name"
                  | "+name"
                  | "+update"
                  | "-update";
          },
          options?: ApiCallOptions,
      ): Promise<GetGlossaryCategoriesHttpResponse>

    • Returns a list of categories for a glossary.

      Parameters

      • id: string

        The glossary id.

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

        an object with query parameters

        • OptionalcountTotal?: boolean

          Optional parameter to request total count for query

        • 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?:
              | "update"
              | "name"
              | "description"
              | "+description"
              | "-description"
              | "-name"
              | "+name"
              | "+update"
              | "-update"

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

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetGlossaryCategoriesHttpResponse>

      GetGlossaryCategoriesHttpError

The glossary id.

an object with query parameters

GetGlossaryCategoriesHttpError

getGlossaryCategory: (
    id: string,
    categoryId: string,
    options?: ApiCallOptions,
) => Promise<GetGlossaryCategoryHttpResponse>

Retrieves a category.

Type declaration

The glossary id.

The category id.

GetGlossaryCategoryHttpError

getGlossaryTerm: (
    id: string,
    termId: string,
    options?: ApiCallOptions,
) => Promise<GetGlossaryTermHttpResponse>

Retrieves a term.

Type declaration

The glossary id.

The term id.

GetGlossaryTermHttpError

getGlossaryTermLinks: (
    id: string,
    termId: string,
    query: {
        countTotal?: boolean;
        filter?: string;
        limit?: number;
        next?: string;
        prev?: string;
        sort?:
            | "type"
            | "created"
            | "+created"
            | "-created"
            | "+type"
            | "-type"
            | "subtype"
            | "+subtype"
            | "-subtype";
    },
    options?: ApiCallOptions,
) => Promise<GetGlossaryTermLinksHttpResponse>

Returns a list of links assigned to a term.

Type declaration

    • (
          id: string,
          termId: string,
          query: {
              countTotal?: boolean;
              filter?: string;
              limit?: number;
              next?: string;
              prev?: string;
              sort?:
                  | "type"
                  | "created"
                  | "+created"
                  | "-created"
                  | "+type"
                  | "-type"
                  | "subtype"
                  | "+subtype"
                  | "-subtype";
          },
          options?: ApiCallOptions,
      ): Promise<GetGlossaryTermLinksHttpResponse>

    • Returns a list of links assigned to a term.

      Parameters

      • id: string

        The glossary id.

      • termId: string

        The term id.

      • query: {
            countTotal?: boolean;
            filter?: string;
            limit?: number;
            next?: string;
            prev?: string;
            sort?:
                | "type"
                | "created"
                | "+created"
                | "-created"
                | "+type"
                | "-type"
                | "subtype"
                | "+subtype"
                | "-subtype";
        }

        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

        • 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?:
              | "type"
              | "created"
              | "+created"
              | "-created"
              | "+type"
              | "-type"
              | "subtype"
              | "+subtype"
              | "-subtype"

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

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetGlossaryTermLinksHttpResponse>

      GetGlossaryTermLinksHttpError

The glossary id.

The term id.

an object with query parameters

GetGlossaryTermLinksHttpError

getGlossaryTermRevisions: (
    id: string,
    termId: string,
    query: {
        countTotal?: boolean;
        limit?: number;
        next?: string;
        prev?: string;
        sort?: "update" | "+update" | "-update";
    },
    options?: ApiCallOptions,
) => Promise<GetGlossaryTermRevisionsHttpResponse>

Retrieves previous revisions of a term.

Type declaration

    • (
          id: string,
          termId: string,
          query: {
              countTotal?: boolean;
              limit?: number;
              next?: string;
              prev?: string;
              sort?: "update" | "+update" | "-update";
          },
          options?: ApiCallOptions,
      ): Promise<GetGlossaryTermRevisionsHttpResponse>

    • Retrieves previous revisions of a term.

      Parameters

      • id: string

        The glossary id.

      • termId: string

        The term id.

      • query: {
            countTotal?: boolean;
            limit?: number;
            next?: string;
            prev?: string;
            sort?: "update" | "+update" | "-update";
        }

        an object with query parameters

        • OptionalcountTotal?: boolean

          Optional parameter to request total count for query

        • 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?: "update" | "+update" | "-update"

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

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetGlossaryTermRevisionsHttpResponse>

      GetGlossaryTermRevisionsHttpError

The glossary id.

The term id.

an object with query parameters

GetGlossaryTermRevisionsHttpError

getGlossaryTerms: (
    id: string,
    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";
    },
    options?: ApiCallOptions,
) => Promise<GetGlossaryTermsHttpResponse>

Returns a list of terms for a glossary.

Type declaration

    • (
          id: string,
          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";
          },
          options?: ApiCallOptions,
      ): Promise<GetGlossaryTermsHttpResponse>

    • Returns a list of terms for a glossary.

      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

      Returns Promise<GetGlossaryTermsHttpResponse>

      GetGlossaryTermsHttpError

The glossary id.

an object with query parameters

GetGlossaryTermsHttpError

importGlossary: (
    query: {
        importerAsFallbackSteward?: boolean;
        lookupUserOnEmail?: boolean;
        spaceId?: string;
    },
    body: QlikGlossary,
    options?: ApiCallOptions,
) => Promise<ImportGlossaryHttpResponse>

Creates a new glossary, including categories and terms, based on a glossary definition file. Supported formats are currently, qlik, atlan and atlas

Type declaration

    • (
          query: {
              importerAsFallbackSteward?: boolean;
              lookupUserOnEmail?: boolean;
              spaceId?: string;
          },
          body: QlikGlossary,
          options?: ApiCallOptions,
      ): Promise<ImportGlossaryHttpResponse>

    • Creates a new glossary, including categories and terms, based on a glossary definition file. Supported formats are currently, qlik, atlan and atlas

      Parameters

      • query: {
            importerAsFallbackSteward?: boolean;
            lookupUserOnEmail?: boolean;
            spaceId?: string;
        }

        an object with query parameters

        • OptionalimporterAsFallbackSteward?: boolean

          Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service.

        • OptionallookupUserOnEmail?: boolean

          Using email in the steward fields to lookup userIds in the identity service

        • OptionalspaceId?: string

          The spaceId (leave blank or omit for personal)

      • body: QlikGlossary

        an object with the body content

      • Optionaloptions: ApiCallOptions

      Returns Promise<ImportGlossaryHttpResponse>

      ImportGlossaryHttpError

an object with query parameters

Param: body

an object with the body content

ImportGlossaryHttpError

patchGlossary: (
    id: string,
    body: JSONPatchArray,
    options?: ApiCallOptions,
) => Promise<PatchGlossaryHttpResponse>

Updates glossary properties with json-patch formatted data

Type declaration

The glossary id.

Param: body

an object with the body content

PatchGlossaryHttpError

patchGlossaryCategory: (
    id: string,
    categoryId: string,
    body: JSONPatchArray,
    options?: ApiCallOptions,
) => Promise<PatchGlossaryCategoryHttpResponse>

Updates category properties with json-patch formatted data

Type declaration

The glossary id.

The category id.

Param: body

an object with the body content

PatchGlossaryCategoryHttpError

patchGlossaryTerm: (
    id: string,
    termId: string,
    body: JSONPatchArray,
    options?: ApiCallOptions,
) => Promise<PatchGlossaryTermHttpResponse>

Updates term properties with json-patch formatted data

Type declaration

The glossary id.

The term id.

Param: body

an object with the body content

PatchGlossaryTermHttpError

updateGlossary: (
    id: string,
    body: CreateGlossary,
    options?: ApiCallOptions,
) => Promise<UpdateGlossaryHttpResponse>

Updates a glossary.

Type declaration

The id of the glossary to update.

Param: body

an object with the body content

UpdateGlossaryHttpError

updateGlossaryCategory: (
    id: string,
    categoryId: string,
    body: CreateCategory,
    options?: ApiCallOptions,
) => Promise<UpdateGlossaryCategoryHttpResponse>

Updates a category.

Type declaration

The glossary id.

The category id.

Param: body

an object with the body content

UpdateGlossaryCategoryHttpError

updateGlossaryTerm: (
    id: string,
    termId: string,
    body: CreateTerm,
    options?: ApiCallOptions,
) => Promise<UpdateGlossaryTermHttpResponse>

Updates a term.

Type declaration

The glossary id.

The term id.

Param: body

an object with the body content

UpdateGlossaryTermHttpError

Settings

Member Visibility

On This Page

Properties