Type Alias GlossariesAPI

Index

Properties

changeGlossaryTermStatus: typeof changeGlossaryTermStatus

Only a steward can verify a term. Once the term is verified only a steward can modify the term. Note that links to resources are considered external relations that can be managed independently of the status of the term.

The glossary id.

The term id.

an object with query parameters

ChangeGlossaryTermStatusHttpError

clearCache: typeof clearCache

Clears the cache for glossaries api requests.

createGlossary: typeof createGlossary

Only a steward can create a glossary.

an object with the body content

CreateGlossaryHttpError

createGlossaryCategory: typeof createGlossaryCategory

Creates a new category.

The glossary id.

an object with the body content

CreateGlossaryCategoryHttpError

createGlossaryTerm: typeof createGlossaryTerm

Creates a new term.

The glossary id.

an object with the body content

CreateGlossaryTermHttpError

createGlossaryTermLink: typeof createGlossaryTermLink

Links to resources are not considered term properties but external relations. Links can be created for terms in any status. Permissions on term and resource determine if the link can be created.

The glossary id.

The term id.

an object with the body content

CreateGlossaryTermLinkHttpError

deleteGlossary: typeof deleteGlossary

Deletes a glossary and all of its terms.

The id of the glossary to delete.

DeleteGlossaryHttpError

deleteGlossaryCategory: typeof deleteGlossaryCategory

Deletes a category.

The id of the glossary.

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

DeleteGlossaryCategoryHttpError

deleteGlossaryTerm: typeof deleteGlossaryTerm

Deletes a term.

The glossary id.

The term id.

DeleteGlossaryTermHttpError

exportGlossary: typeof exportGlossary

Exports a glossary.

The glossary id.

ExportGlossaryHttpError

getGlossaries: typeof getGlossaries

Returns all glossaries.

an object with query parameters

GetGlossariesHttpError

getGlossary: typeof getGlossary

Retrieves a glossary.

The id of the glossary to retrieve.

GetGlossaryHttpError

getGlossaryCategories: typeof getGlossaryCategories

Returns a list of categories for a glossary.

The glossary id.

an object with query parameters

GetGlossaryCategoriesHttpError

getGlossaryCategory: typeof getGlossaryCategory

Retrieves a category.

The glossary id.

The category id.

GetGlossaryCategoryHttpError

getGlossaryTerm: typeof getGlossaryTerm

Retrieves a term.

The glossary id.

The term id.

GetGlossaryTermHttpError

getGlossaryTermLinks: typeof getGlossaryTermLinks

Returns a list of links assigned to a term.

The glossary id.

The term id.

an object with query parameters

GetGlossaryTermLinksHttpError

getGlossaryTermRevisions: typeof getGlossaryTermRevisions

Retrieves previous revisions of a term.

The glossary id.

The term id.

an object with query parameters

GetGlossaryTermRevisionsHttpError

getGlossaryTerms: typeof getGlossaryTerms

Returns a list of terms for a glossary.

The glossary id.

an object with query parameters

GetGlossaryTermsHttpError

importGlossary: typeof importGlossary

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

an object with query parameters

an object with the body content

ImportGlossaryHttpError

patchGlossary: typeof patchGlossary

Updates glossary properties with json-patch formatted data.

The glossary id.

an object with the body content

PatchGlossaryHttpError

patchGlossaryCategory: typeof patchGlossaryCategory

Updates category properties with json-patch formatted data.

The glossary id.

The category id.

an object with the body content

PatchGlossaryCategoryHttpError

patchGlossaryTerm: typeof patchGlossaryTerm

Updates term properties with json-patch formatted data

The glossary id.

The term id.

an object with the body content

PatchGlossaryTermHttpError

updateGlossary: typeof updateGlossary

Updates a glossary.

The id of the glossary to update.

an object with the body content

UpdateGlossaryHttpError

updateGlossaryCategory: typeof updateGlossaryCategory

Updates a category.

The glossary id.

The category id.

an object with the body content

UpdateGlossaryCategoryHttpError

updateGlossaryTerm: typeof updateGlossaryTerm

Updates a term.

The glossary id.

The term id.

an object with the body content

UpdateGlossaryTermHttpError