How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qlik Glossaries API

A glossary is a collection of common and agreed upon (business) terms, typically focused on defining the meaning of data and described in terms that everyone understands.

Qlik Glossaries API is one of 82 APIs that Qlik Sense APIs publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Business Intelligence, Data Governance, and REST. The published artifact set on APIs.io includes API documentation, an API reference, and an OpenAPI specification.

This API exposes 24 operations across 11 paths, organized into 4 resource areas, and defines 43 schemas. It is described by OpenAPI 3.0.0.

Requests are made against a single base URL, https://{tenant}.{region}.qlikcloud.com.

24 operations 11 paths 43 schemas 3 DELETE9 GET3 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries
Resource Areas
4

Paths & Operations 24

Across 11 paths, the API surfaces 24 operations — 3 DELETE, 9 GET, 3 PATCH, 6 POST, 3 PUT. They span 4 resource areas: glossaries, categories, terms, links. Each is listed below with its method, path, parameters, and response codes.

glossaries 8
GET
/api/v1/glossaries
Returns all glossaries.
5 params → 200400403
POST
/api/v1/glossaries
Creates a new glossary.
body → 201400403
GET
/api/v1/glossaries/{id}
Retrieves a glossary.
1 param → 200400403404
PATCH
/api/v1/glossaries/{id}
Updates glossary properties with json-patch formatted data.
2 params body → 204400401403404429
PUT
/api/v1/glossaries/{id}
Updates a glossary.
2 params body → 200400403404
DELETE
/api/v1/glossaries/{id}
Deletes a glossary and all of its terms.
1 param → 204400403404
GET
/api/v1/glossaries/{id}/actions/export
Exports a glossary.
2 params → 200400403404
POST
/api/v1/glossaries/actions/import
Imports a glossary from file.
3 params body → 201400403404
categories 6
GET
/api/v1/glossaries/{id}/categories
Returns a list of categories for a glossary.
6 params → 200400403404
POST
/api/v1/glossaries/{id}/categories
Creates a new category.
1 param body → 201400403404
GET
/api/v1/glossaries/{id}/categories/{categoryId}
Retrieves a category.
3 params → 200400403404
PATCH
/api/v1/glossaries/{id}/categories/{categoryId}
Updates category properties with json-patch formatted data.
3 params body → 204400401403404429
PUT
/api/v1/glossaries/{id}/categories/{categoryId}
Updates a category.
3 params body → 200400403404
DELETE
/api/v1/glossaries/{id}/categories/{categoryId}
Deletes a category.
2 params → 204400403404
terms 8
GET
/api/v1/glossaries/{id}/terms
Returns a list of terms for a glossary.
7 params → 200400403404
POST
/api/v1/glossaries/{id}/terms
Creates a new term.
1 param body → 201400403404
GET
/api/v1/glossaries/{id}/terms/{termId}
Retrieves a term.
2 params → 200400403404
PATCH
/api/v1/glossaries/{id}/terms/{termId}
Updates term properties with json-patch formatted data
3 params body → 204400401403404412429
PUT
/api/v1/glossaries/{id}/terms/{termId}
Updates a term.
3 params body → 200400403404412
DELETE
/api/v1/glossaries/{id}/terms/{termId}
Deletes a term.
2 params → 204400403404
POST
/api/v1/glossaries/{id}/terms/{termId}/actions/change-status
Changes the status of the term.
4 params → 200400403404412
GET
/api/v1/glossaries/{id}/terms/{termId}/revisions
Retrieves previous revisions of a term.
7 params → 200400403404
links 2
GET
/api/v1/glossaries/{id}/terms/{termId}/links
Returns a list of links assigned to a term.
8 params → 200400403404
POST
/api/v1/glossaries/{id}/terms/{termId}/links
Creates a new link to a term.
3 params body → 201400403404412

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are term (18 properties), termLinksTo (15 properties), exportGlossary (14 properties), glossary (12 properties). Each schema is shown below with its type and property counts.

atlanEntity
object
6 properties
atlanEntityAttributes
object
10 properties
atlanGlossary
object
Atlan glossary format. For more information, see https://docs.atlan.com/
2 properties
atlanRelationEntity
object
4 properties
atlanRelationshipAttributes
object
8 properties
atlanResourceLink
object
2 properties
atlanTermHeader
object
7 properties
atlasCategory
object
5 properties
atlasGlossary
object
9 properties
atlasTerm
object
8 properties
categoriesResult
object
3 properties 1 required
category
object
10 properties 8 required
createCategory
object
4 properties
createGlossary
object
6 properties 1 required
createTerm
object
9 properties 1 required
errorResponse
object
2 properties
errorResponseBadRequest
object
Custom error codes BG-1 - Context JWT is missing tenantId. BG-2 - Context JWT is missing userId. BG-4 - Invalid or unsupported Content Type. Valid types are: a…
2 properties
errorResponseCode
object
3 properties
errorResponseForbidden
object
Custom error codes BG-3 - Access denied, no read access BG-30 - Feature not enabled on tenant.
2 properties
errorResponseNotFound
object
Custom error codes BG-8 - Glossary not found BG-9 - Category not found BG-10 - Term not found
2 properties
exportCategory
object
5 properties
exportGlossary
object
14 properties
exportTerm
object
11 properties
glossariesResult
object
3 properties
glossary
object
12 properties 12 required
importCategory
object
6 properties
importOwner
object
3 properties
importTerm
object
11 properties
JSONPatch
object
A JSON Patch document as defined in https://tools.ietf.org/html/rfc6902.
3 properties 3 required
JSONPatchArray
array
An array of JSON Patch documents
linksResult
object
3 properties
pageLink
object
1 property
pageLinks
object
URLs to a resource request
3 properties
qlikGlossary
object
8 properties
resultMeta
object
1 property
stewardDetail
object
3 properties
term
object
18 properties 14 required
termCreateLinksTo
object
Describes links to other data assets such as analytics applications or dataset. Note: When linking to a subresource (e.g., a master dimension, master measure,…
6 properties 2 required
termLinksTo
object
Describes links to other entities such as qlik charts, dataset columns etc.
15 properties
termRelatesTo
object
2 properties 2 required
termsResult
object
3 properties 1 required
termStatus
object
Terms status is used determine the status of a term
3 properties 3 required
termTemplate
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qliksense-glossaries.json Raw ↑

Other APIs Qlik Sense APIs publishes across the network.

Qlik Engine API
Qlik Server-Side Extension Protocol
Qlik Cloud System Events
Qlik MCP Server
Qlik Apps API
Qlik Change stores API
Qlik Adaptive cards API
Qlik ODAG apps API
Qlik ODAG links API
Qlik ODAG requests API
Qlik ODAG settings API
Qlik API keys API
Where this information came from

This is an independent, third-party profile of Qlik Glossaries API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.