Glossaries

Download specification

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.

Endpoints

Skip to section

GET	/v1/glossaries
POST	/v1/glossaries
GET	/v1/glossaries/{id}
PATCH	/v1/glossaries/{id}
PUT	/v1/glossaries/{id}
DELETE	/v1/glossaries/{id}
GET	/v1/glossaries/{id}/actions/export
GET	/v1/glossaries/{id}/categories
POST	/v1/glossaries/{id}/categories
GET	/v1/glossaries/{id}/categories/{categoryId}
PATCH	/v1/glossaries/{id}/categories/{categoryId}
PUT	/v1/glossaries/{id}/categories/{categoryId}
DELETE	/v1/glossaries/{id}/categories/{categoryId}
GET	/v1/glossaries/{id}/terms
POST	/v1/glossaries/{id}/terms
GET	/v1/glossaries/{id}/terms/{termId}
PATCH	/v1/glossaries/{id}/terms/{termId}
PUT	/v1/glossaries/{id}/terms/{termId}
DELETE	/v1/glossaries/{id}/terms/{termId}
POST	/v1/glossaries/{id}/terms/{termId}/actions/change-status
GET	/v1/glossaries/{id}/terms/{termId}/links
POST	/v1/glossaries/{id}/terms/{termId}/links
GET	/v1/glossaries/{id}/terms/{termId}/revisions
POST	/v1/glossaries/actions/import

Returns all glossaries.

manage

Facts GET /v1/glossaries

Rate limit

required

Tier 1 (1000 requests per minute)

Query Parameters GET /v1/glossaries

countTotal boolean	Optional parameter to request total count for query
limit default=20, minimum=1, maximum=100 integer	The number of glossaries to get.
next string	Optional parameter to request the next page.
prev string	Optional parameter to request the previous page.
sort string	Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: name +name -name description +description -description

Responses GET /v1/glossaries

200 application/json glossariesResult	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The user does not have privileges to perform the requested action.

GET/v1/glossaries

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Organization wide glossary",
      "tags": [
        "Red",
        "Sales"
      ],
      "ownerId": "507f191e810c19729de860ea",
      "spaceId": "507f191e810c19729de860ea",
      "overview": "string",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "description": "This glossary contains definitions and concepts of business terms.",
      "termTemplate": {
        "relatedInformation": "string"
      }
    }
  ],
  "meta": {
    "countTotal": 0
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

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

manage

Facts POST /v1/glossaries

Rate limit

required

Tier 2 (100 requests per minute)

Request Body POST /v1/glossaries

application/json

createGlossary

No description

Responses POST /v1/glossaries

201 application/json glossary	Successfully created a new glossary.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The user does not have privileges to perform the requested action.

POST/v1/glossaries

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"string","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"string"}}'

Request POST /v1/glossaries

{
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Response POST /v1/glossaries

{
  "id": "507f191e810c19729de860ea",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Retrieves a glossary.

manage

Facts GET /v1/glossaries/{id}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}

required

string<uuid>

The id of the glossary to retrieve.

Responses GET /v1/glossaries/{id}

200 application/json glossary	Successfully retrieved the glossary.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The glossary is not found

GET/v1/glossaries/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}

{
  "id": "507f191e810c19729de860ea",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Updates glossary properties with json-patch formated data

manage

Facts PATCH /v1/glossaries/{id}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PATCH /v1/glossaries/{id}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched.

Path Parameters PATCH /v1/glossaries/{id}

required

string<uuid>

The glossary id.

Request Body PATCH /v1/glossaries/{id}

application/json

Array<JSONPatch>

No description

Responses PATCH /v1/glossaries/{id}

204 object	Glossary updated successfully.
400 application/json errorResponse	Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.
401 application/json errorResponse	Not authorized.
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The term to patch was not found.
429 application/json errorResponse	Request has been rate limited.

PATCH/v1/glossaries/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}]'

Request PATCH /v1/glossaries/{id}

[
  {
    "op": "replace",
    "path": "name",
    "value": "new name"
  },
  {
    "op": "replace",
    "path": "description",
    "value": "new description"
  }
]

Updates a glossary.

manage

Facts PUT /v1/glossaries/{id}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PUT /v1/glossaries/{id}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched.

Path Parameters PUT /v1/glossaries/{id}

required

string<uuid>

The id of the glossary to update.

Request Body PUT /v1/glossaries/{id}

application/json

createGlossary

No description

Responses PUT /v1/glossaries/{id}

200 application/json glossary	Successfully updated the glossary.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

PUT/v1/glossaries/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"string","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"string"}}'

Request PUT /v1/glossaries/{id}

{
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Response PUT /v1/glossaries/{id}

{
  "id": "507f191e810c19729de860ea",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Deletes a glossary and all of its terms.

manage

Facts DELETE /v1/glossaries/{id}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/glossaries/{id}

required

string<uuid>

The id of the glossary to delete.

Responses DELETE /v1/glossaries/{id}

204 object	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The glossary is not found

DELETE/v1/glossaries/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Exports a glossary.

manage

Facts GET /v1/glossaries/{id}/actions/export

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/actions/export

required

string<uuid>

The glossary id.

Responses GET /v1/glossaries/{id}/actions/export

200 application/json fullGlossary	Successfully exported the glossary.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The glossary is not found

GET/v1/glossaries/{id}/actions/export

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/actions/export" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/actions/export

{
  "id": "507f191e810c19729de860ea",
  "name": "string",
  "tags": [
    "tag1",
    "tag2"
  ],
  "terms": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Earnings Before Interest and Tax (EBIT)",
      "tags": [
        "Finance",
        "Accounting"
      ],
      "status": {
        "type": "draft",
        "updatedAt": "2021-10-02T14:20:50.52Z",
        "updatedBy": "507f191e810c19729de860ea"
      },
      "linksTo": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Sales App",
          "type": "definition",
          "title": "string",
          "status": 201,
          "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
          "createdAt": "2021-10-02T14:20:50.52Z",
          "createdBy": "507f191e810c19729de860ea",
          "resourceId": "507f191e810c19729de860ea",
          "resourceType": "app",
          "subResourceId": "507f191e810c19729de860ea",
          "resourceSpaceId": "507f191e810c19729de860ea",
          "subResourceName": "Sales YTD",
          "subResourceType": "master_dimension"
        }
      ],
      "revision": 0,
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {
          "type": "isA",
          "termId": "507f191e810c19729de860ea"
        }
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "categories": [
        "507f191e810c19729de860ea",
        "507f191e810c19729de860eb"
      ],
      "glossaryId": "507f191e810c19729de860ea",
      "description": "string",
      "abbreviation": "EBIT",
      "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
    }
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "glossary overview",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "string",
      "parentId": "507f191e810c19729de860ea",
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "glossaryId": "507f191e810c19729de860ea",
      "description": "string"
    }
  ],
  "description": "string"
}

Returns a list of categories for a glossary.

manage

Facts GET /v1/glossaries/{id}/categories

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/categories

required

string<uuid>

The glossary id.

Query Parameters GET /v1/glossaries/{id}/categories

countTotal boolean	Optional parameter to request total count for query
limit default=20, minimum=1, maximum=100 integer	The number of terms to get.
next string	Optional parameter to request the next page.
prev string	Optional parameter to request the previous page.
sort string	Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: description +description -description name +name -name update +update -update

Responses GET /v1/glossaries/{id}/categories

200 application/json categoriesResult	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/categories

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/categories

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "string",
      "parentId": "507f191e810c19729de860ea",
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "glossaryId": "507f191e810c19729de860ea",
      "description": "string"
    }
  ],
  "meta": {
    "countTotal": 0
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new category.

manage

Facts POST /v1/glossaries/{id}/categories

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/glossaries/{id}/categories

required

string<uuid>

The glossary id.

Request Body POST /v1/glossaries/{id}/categories

application/json

createCategory

No description

Responses POST /v1/glossaries/{id}/categories

201 application/json category	Successfully created a new category.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

POST/v1/glossaries/{id}/categories

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","parentId":"507f191e810c19729de860ea","stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"description":"string"}'

Request POST /v1/glossaries/{id}/categories

{
  "name": "string",
  "parentId": "507f191e810c19729de860ea",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "description": "string"
}

Response POST /v1/glossaries/{id}/categories

{
  "id": "507f191e810c19729de860ea",
  "name": "string",
  "parentId": "507f191e810c19729de860ea",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string"
}

Retrieves a category.

manage

Facts GET /v1/glossaries/{id}/categories/{categoryId}

Rate limit

required

Tier 1 (1000 requests per minute)

Header Parameters GET /v1/glossaries/{id}/categories/{categoryId}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched.

Path Parameters GET /v1/glossaries/{id}/categories/{categoryId}

categoryId required string<uuid>	The category id.
id required string<uuid>	The glossary id.

Responses GET /v1/glossaries/{id}/categories/{categoryId}

200 application/json category	Successfully retrieved the category.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/categories/{categoryId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/categories/{categoryId}

{
  "id": "507f191e810c19729de860ea",
  "name": "string",
  "parentId": "507f191e810c19729de860ea",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string"
}

Updates category properties with json-patch formated data

manage

Facts PATCH /v1/glossaries/{id}/categories/{categoryId}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PATCH /v1/glossaries/{id}/categories/{categoryId}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched.

Path Parameters PATCH /v1/glossaries/{id}/categories/{categoryId}

categoryId required string<uuid>	The category id.
id required string<uuid>	The glossary id.

Request Body PATCH /v1/glossaries/{id}/categories/{categoryId}

application/json

Array<JSONPatch>

No description

Responses PATCH /v1/glossaries/{id}/categories/{categoryId}

204 object	Category updated successfully.
400 application/json errorResponse	Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.
401 application/json errorResponse	Not authorized.
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The term to patch was not found.
429 application/json errorResponse	Request has been rate limited.

PATCH/v1/glossaries/{id}/categories/{categoryId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}]'

Request PATCH /v1/glossaries/{id}/categories/{categoryId}

[
  {
    "op": "replace",
    "path": "name",
    "value": "new name"
  },
  {
    "op": "replace",
    "path": "description",
    "value": "new description"
  }
]

Updates a category.

manage

Facts PUT /v1/glossaries/{id}/categories/{categoryId}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PUT /v1/glossaries/{id}/categories/{categoryId}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched.

Path Parameters PUT /v1/glossaries/{id}/categories/{categoryId}

categoryId required string<uuid>	The category id.
id required string<uuid>	The glossary id.

Request Body PUT /v1/glossaries/{id}/categories/{categoryId}

application/json

createCategory

No description

Responses PUT /v1/glossaries/{id}/categories/{categoryId}

200 application/json category	Successfully updated the category.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

PUT/v1/glossaries/{id}/categories/{categoryId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","parentId":"507f191e810c19729de860ea","stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"description":"string"}'

Request PUT /v1/glossaries/{id}/categories/{categoryId}

{
  "name": "string",
  "parentId": "507f191e810c19729de860ea",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "description": "string"
}

Response PUT /v1/glossaries/{id}/categories/{categoryId}

{
  "id": "507f191e810c19729de860ea",
  "name": "string",
  "parentId": "507f191e810c19729de860ea",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string"
}

Deletes a category.

manage

Facts DELETE /v1/glossaries/{id}/categories/{categoryId}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/glossaries/{id}/categories/{categoryId}

categoryId required string<uuid>	The id for the category to delete. All subcategories are also deleted
id required string<uuid>	The id of the glossary.

Responses DELETE /v1/glossaries/{id}/categories/{categoryId}

204 object	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

DELETE/v1/glossaries/{id}/categories/{categoryId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

Returns a list of terms for a glossary.

manage

Facts GET /v1/glossaries/{id}/terms

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/terms

required

string<uuid>

The glossary id.

Query Parameters GET /v1/glossaries/{id}/terms

countTotal boolean	Optional parameter to request total count for query
filter string	Optional SCIM filter to be used to filter terms Usable fields are id name relatedInformation description abbreviation tags stewards status categories
limit default=20, minimum=1, maximum=100 integer	The number of terms to get.
next string	Optional parameter to request the next page.
prev string	Optional parameter to request the previous page.
sort string	Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: abbreviation +abbreviation -abbreviation description +description -description name +name -name status +status -status updated +updated -updated

Responses GET /v1/glossaries/{id}/terms

200 application/json termsResult	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/terms

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/terms

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Earnings Before Interest and Tax (EBIT)",
      "tags": [
        "Finance",
        "Accounting"
      ],
      "status": {
        "type": "draft",
        "updatedAt": "2021-10-02T14:20:50.52Z",
        "updatedBy": "507f191e810c19729de860ea"
      },
      "linksTo": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Sales App",
          "type": "definition",
          "title": "string",
          "status": 201,
          "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
          "createdAt": "2021-10-02T14:20:50.52Z",
          "createdBy": "507f191e810c19729de860ea",
          "resourceId": "507f191e810c19729de860ea",
          "resourceType": "app",
          "subResourceId": "507f191e810c19729de860ea",
          "resourceSpaceId": "507f191e810c19729de860ea",
          "subResourceName": "Sales YTD",
          "subResourceType": "master_dimension"
        }
      ],
      "revision": 0,
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {
          "type": "isA",
          "termId": "507f191e810c19729de860ea"
        }
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "categories": [
        "507f191e810c19729de860ea",
        "507f191e810c19729de860eb"
      ],
      "glossaryId": "507f191e810c19729de860ea",
      "description": "string",
      "abbreviation": "EBIT",
      "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
    }
  ],
  "meta": {
    "countTotal": 0
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new term.

manage

Facts POST /v1/glossaries/{id}/terms

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters POST /v1/glossaries/{id}/terms

required

string<uuid>

The glossary id.

Request Body POST /v1/glossaries/{id}/terms

application/json

createTerm

No description

Responses POST /v1/glossaries/{id}/terms

201 application/json term	Successfully created a new term.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

POST/v1/glossaries/{id}/terms

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{"type":"isA","termId":"507f191e810c19729de860ea"}],"categories":["507f191e810c19729de860ea","507f191e810c19729de860eb"],"description":"string","abbreviation":"EBIT","relatedInformation":"In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."}'

Request POST /v1/glossaries/{id}/terms

{
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "linksTo": [
    {
      "type": "definition",
      "resourceId": "string",
      "resourceType": "app",
      "subResourceId": "string",
      "subResourceName": "string",
      "subResourceType": "master_dimension"
    }
  ],
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Response POST /v1/glossaries/{id}/terms

{
  "id": "507f191e810c19729de860ea",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Sales App",
      "type": "definition",
      "title": "string",
      "status": 201,
      "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "resourceId": "507f191e810c19729de860ea",
      "resourceType": "app",
      "subResourceId": "507f191e810c19729de860ea",
      "resourceSpaceId": "507f191e810c19729de860ea",
      "subResourceName": "Sales YTD",
      "subResourceType": "master_dimension"
    }
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Retrieves a term.

manage

Facts GET /v1/glossaries/{id}/terms/{termId}

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/terms/{termId}

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Responses GET /v1/glossaries/{id}/terms/{termId}

200 application/json term	Successfully retrieved the term.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/terms/{termId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/terms/{termId}

{
  "id": "507f191e810c19729de860ea",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Sales App",
      "type": "definition",
      "title": "string",
      "status": 201,
      "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "resourceId": "507f191e810c19729de860ea",
      "resourceType": "app",
      "subResourceId": "507f191e810c19729de860ea",
      "resourceSpaceId": "507f191e810c19729de860ea",
      "subResourceName": "Sales YTD",
      "subResourceType": "master_dimension"
    }
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Updates term properties with json-patch formated data

manage

Facts PATCH /v1/glossaries/{id}/terms/{termId}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PATCH /v1/glossaries/{id}/terms/{termId}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched.

Path Parameters PATCH /v1/glossaries/{id}/terms/{termId}

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Request Body PATCH /v1/glossaries/{id}/terms/{termId}

application/json

Array<JSONPatch>

No description

Responses PATCH /v1/glossaries/{id}/terms/{termId}

204 object	Term updated successfully.
400 application/json errorResponse	Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.
401 application/json errorResponse	Not authorized.
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The term to patch was not found.
412 application/json errorResponse	Conditional update failed. Trying to modify an old version.
429 application/json errorResponse	Request has been rate limited.

PATCH/v1/glossaries/{id}/terms/{termId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}]'

Request PATCH /v1/glossaries/{id}/terms/{termId}

[
  {
    "op": "replace",
    "path": "name",
    "value": "new name"
  },
  {
    "op": "replace",
    "path": "description",
    "value": "new description"
  }
]

Updates a term.

manage

Facts PUT /v1/glossaries/{id}/terms/{termId}

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters PUT /v1/glossaries/{id}/terms/{termId}

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched.

Path Parameters PUT /v1/glossaries/{id}/terms/{termId}

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Request Body PUT /v1/glossaries/{id}/terms/{termId}

application/json

createTerm

No description

Responses PUT /v1/glossaries/{id}/terms/{termId}

200 application/json term	Successfully updated the term.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found
412 application/json errorResponse	Conditional update failed. Trying to modify an old version.

PUT/v1/glossaries/{id}/terms/{termId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{"type":"isA","termId":"507f191e810c19729de860ea"}],"categories":["507f191e810c19729de860ea","507f191e810c19729de860eb"],"description":"string","abbreviation":"EBIT","relatedInformation":"In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."}'

Request PUT /v1/glossaries/{id}/terms/{termId}

{
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "linksTo": [
    {
      "type": "definition",
      "resourceId": "string",
      "resourceType": "app",
      "subResourceId": "string",
      "subResourceName": "string",
      "subResourceType": "master_dimension"
    }
  ],
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Response PUT /v1/glossaries/{id}/terms/{termId}

{
  "id": "507f191e810c19729de860ea",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Sales App",
      "type": "definition",
      "title": "string",
      "status": 201,
      "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "resourceId": "507f191e810c19729de860ea",
      "resourceType": "app",
      "subResourceId": "507f191e810c19729de860ea",
      "resourceSpaceId": "507f191e810c19729de860ea",
      "subResourceName": "Sales YTD",
      "subResourceType": "master_dimension"
    }
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Deletes a term.

manage

Facts DELETE /v1/glossaries/{id}/terms/{termId}

Rate limit

required

Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/glossaries/{id}/terms/{termId}

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Responses DELETE /v1/glossaries/{id}/terms/{termId}

204 object	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

DELETE/v1/glossaries/{id}/terms/{termId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

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.

manage

Facts POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched.

Path Parameters POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Query Parameters POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

status

required

string

The status to update to.

Enum:

draft

verified

deprecated

Responses POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

200 application/json term	Successfully updated the term status.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found
412 application/json errorResponse	Conditional update failed. Trying to modify an old version.

POST/v1/glossaries/{id}/terms/{termId}/actions/change-status

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/actions/change-status" \
 -X POST \
 -H "Authorization: Bearer <API-key>"

Response POST /v1/glossaries/{id}/terms/{termId}/actions/change-status

{
  "id": "507f191e810c19729de860ea",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Sales App",
      "type": "definition",
      "title": "string",
      "status": 201,
      "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "resourceId": "507f191e810c19729de860ea",
      "resourceType": "app",
      "subResourceId": "507f191e810c19729de860ea",
      "resourceSpaceId": "507f191e810c19729de860ea",
      "subResourceName": "Sales YTD",
      "subResourceType": "master_dimension"
    }
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "507f191e810c19729de860ea"
    }
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "507f191e810c19729de860ea",
    "507f191e810c19729de860eb"
  ],
  "glossaryId": "507f191e810c19729de860ea",
  "description": "string",
  "abbreviation": "EBIT",
  "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
}

Returns a list of links assigned to a term.

manage

Facts GET /v1/glossaries/{id}/terms/{termId}/links

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/terms/{termId}/links

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Query Parameters GET /v1/glossaries/{id}/terms/{termId}/links

countTotal boolean	Optional parameter to request total count for query
filter string	Optional SCIM filter to be used to filter terms
limit default=20, minimum=1, maximum=100 integer	The number of terms to get.
next string	Optional parameter to request the next page.
prev string	Optional parameter to request the previous page.
sort string	Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: type +type -type subtype +subtype -subtype created +created -created

Responses GET /v1/glossaries/{id}/terms/{termId}/links

200 application/json linksResult	Successful Operation.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/terms/{termId}/links

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/links" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/terms/{termId}/links

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Sales App",
      "type": "definition",
      "title": "string",
      "status": 201,
      "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "resourceId": "507f191e810c19729de860ea",
      "resourceType": "app",
      "subResourceId": "507f191e810c19729de860ea",
      "resourceSpaceId": "507f191e810c19729de860ea",
      "subResourceName": "Sales YTD",
      "subResourceType": "master_dimension"
    }
  ],
  "meta": {
    "countTotal": 0
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new link to a term.

manage

Facts POST /v1/glossaries/{id}/terms/{termId}/links

Rate limit

required

Tier 2 (100 requests per minute)

Header Parameters POST /v1/glossaries/{id}/terms/{termId}/links

if-match

string

Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched.

Path Parameters POST /v1/glossaries/{id}/terms/{termId}/links

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Request Body POST /v1/glossaries/{id}/terms/{termId}/links

application/json

termCreateLinksTo

No description

Responses POST /v1/glossaries/{id}/terms/{termId}/links

201 application/json termLinksTo	Successfully created the link.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found
412 application/json errorResponse	Conditional update failed. Trying to modify an old version.

POST/v1/glossaries/{id}/terms/{termId}/links

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/links" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}'

Request POST /v1/glossaries/{id}/terms/{termId}/links

{
  "type": "definition",
  "resourceId": "string",
  "resourceType": "app",
  "subResourceId": "string",
  "subResourceName": "string",
  "subResourceType": "master_dimension"
}

Response POST /v1/glossaries/{id}/terms/{termId}/links

{
  "id": "507f191e810c19729de860ea",
  "name": "Sales App",
  "type": "definition",
  "title": "string",
  "status": 201,
  "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "resourceId": "507f191e810c19729de860ea",
  "resourceType": "app",
  "subResourceId": "507f191e810c19729de860ea",
  "resourceSpaceId": "507f191e810c19729de860ea",
  "subResourceName": "Sales YTD",
  "subResourceType": "master_dimension"
}

Retrieves previous revisions of a term.

manage

Facts GET /v1/glossaries/{id}/terms/{termId}/revisions

Rate limit

required

Tier 1 (1000 requests per minute)

Path Parameters GET /v1/glossaries/{id}/terms/{termId}/revisions

id required string<uuid>	The glossary id.
termId required string<uuid>	The term id.

Query Parameters GET /v1/glossaries/{id}/terms/{termId}/revisions

countTotal boolean	Optional parameter to request total count for query
limit default=20, minimum=1, maximum=100 integer	The number of terms to get.
next string	Optional parameter to request the next page.
prev string	Optional parameter to request the previous page.
sort string	Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: update +update -update

Responses GET /v1/glossaries/{id}/terms/{termId}/revisions

200 application/json termsResult	Successfully retrieved the revisions.
400 application/json errorResponse	The request is in incorrect format
403 application/json errorResponse	The operation failed due to insufficient permissions.
404 application/json errorResponse	The record is not found

GET/v1/glossaries/{id}/terms/{termId}/revisions

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/revisions" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/glossaries/{id}/terms/{termId}/revisions

{
  "data": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Earnings Before Interest and Tax (EBIT)",
      "tags": [
        "Finance",
        "Accounting"
      ],
      "status": {
        "type": "draft",
        "updatedAt": "2021-10-02T14:20:50.52Z",
        "updatedBy": "507f191e810c19729de860ea"
      },
      "linksTo": [
        {
          "id": "507f191e810c19729de860ea",
          "name": "Sales App",
          "type": "definition",
          "title": "string",
          "status": 201,
          "openUrl": "https://tenant.qlik.com/sense/app/52bc4307-f9f2-4ce6-b521-67ca87018759",
          "createdAt": "2021-10-02T14:20:50.52Z",
          "createdBy": "507f191e810c19729de860ea",
          "resourceId": "507f191e810c19729de860ea",
          "resourceType": "app",
          "subResourceId": "507f191e810c19729de860ea",
          "resourceSpaceId": "507f191e810c19729de860ea",
          "subResourceName": "Sales YTD",
          "subResourceType": "master_dimension"
        }
      ],
      "revision": 0,
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {
          "type": "isA",
          "termId": "507f191e810c19729de860ea"
        }
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "categories": [
        "507f191e810c19729de860ea",
        "507f191e810c19729de860eb"
      ],
      "glossaryId": "507f191e810c19729de860ea",
      "description": "string",
      "abbreviation": "EBIT",
      "relatedInformation": "In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses."
    }
  ],
  "meta": {
    "countTotal": 0
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

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

manage

Facts POST /v1/glossaries/actions/import

Rate limit

required

Tier 2 (100 requests per minute)

Query Parameters POST /v1/glossaries/actions/import

spaceId

string<uuid>

The spaceId (leave blank or omit for personal)

Request Body POST /v1/glossaries/actions/import

application/json qlikGlossary	No description
application/json+qlik qlikGlossary	No description
application/json+atlan atlanGlossary	No description
application/json+atlas atlasGlossary	No description

Responses POST /v1/glossaries/actions/import

201 application/json glossary	Successfully created a new glossary.
400 application/json errorResponseBadRequest	See custom codes
403 application/json errorResponseForbidden	See custom codes
404 application/json errorResponseNotFound	See custom codes

POST/v1/glossaries/actions/import

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/actions/import" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","tags":["tag1","tag2"],"terms":[{"name":"name","tags":["tag1","tag2"],"owner":[{"name":"Joe Smith","email":"joe.smith@qlik.com","userId":"507f191e810c19729de860ea"}],"linksTo":[{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}],"relatesTo":[{"type":"isA","termId":"507f191e810c19729de860ea"}],"categories":["507f191e810c19729de860ea","507f191e810c19729de860ea"],"description":"description","abbreviation":"abbr"}],"spaceId":"507f191e810c19729de860ea","overview":"string","categories":[{"name":"string","parentId":"507f191e810c19729de860ea","stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"description":"string"}],"description":"string"}'

Request POST /v1/glossaries/actions/import

{
  "name": "string",
  "tags": [
    "tag1",
    "tag2"
  ],
  "terms": [
    {
      "name": "name",
      "tags": [
        "tag1",
        "tag2"
      ],
      "owner": [
        {
          "name": "Joe Smith",
          "email": "joe.smith@qlik.com",
          "userId": "507f191e810c19729de860ea"
        }
      ],
      "linksTo": [
        {
          "type": "definition",
          "resourceId": "string",
          "resourceType": "app",
          "subResourceId": "string",
          "subResourceName": "string",
          "subResourceType": "master_dimension"
        }
      ],
      "relatesTo": [
        {
          "type": "isA",
          "termId": "507f191e810c19729de860ea"
        }
      ],
      "categories": [
        "507f191e810c19729de860ea",
        "507f191e810c19729de860ea"
      ],
      "description": "description",
      "abbreviation": "abbr"
    }
  ],
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "categories": [
    {
      "name": "string",
      "parentId": "507f191e810c19729de860ea",
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "description": "string"
    }
  ],
  "description": "string"
}

Response POST /v1/glossaries/actions/import

{
  "id": "507f191e810c19729de860ea",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "description": "This glossary contains definitions and concepts of business terms.",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

atlanEntity

object

Properties

guid string	No description
labels Array<string>	No description
status string	No description
typeName string	No description
attributes atlanEntityAttributes	No description
relationshipAttributes atlanRelationshipAttributes	No description

atlanEntityAttributes

object

Properties

guid string	No description
name string	No description
usage string	No description
examples Array<string>	No description
relations atlanResourceLink	No description
displayText string	No description
abbreviation string	No description
relationGuid string	No description
parentCategory string	No description
userDescription string	No description

atlanGlossary

object

Atlan glossary format. See https://apidocs.atlan.com/

Properties

entity atlanEntity	No description
referredEntities Array<atlanEntity>	No description

atlanRelationEntity

object

Properties

guid string	No description
typeName string	No description
displayText string	No description
entityStatus string	No description

atlanRelationshipAttributes

object

Properties

isA atlanTermHeader	No description
terms atlanRelationEntity	No description
seeAlso atlanTermHeader	No description
antonyms atlanTermHeader	No description
synonyms atlanTermHeader	No description
categories atlanRelationEntity	No description
classifies atlanTermHeader	No description
replacedBy atlanTermHeader	No description

atlanResourceLink

object

Properties

url string	No description
displayName string	No description

atlanTermHeader

object

Properties

guid string	No description
steward string	No description
expression string	No description
description string	No description
displayText string	No description
entityStatus string	No description
relationGuid string	No description

atlasCategory

object

Properties

description string	No description
displayText string	No description
categoryGuid string	No description
relationGuid string	No description
parentCategoryGuid string	No description

atlasGlossary

object

Properties

guid string	No description
name string	No description
terms Array<atlasTerm>	No description
usage string	No description
language string	No description
categories Array<atlasCategory>	No description
qualifiedName string	No description
longDescription string	No description
shortDescription string	No description

atlasTerm

object

Properties

source string	No description
status string	No description
steward string	No description
termGuid string	No description
expression string	No description
description string	No description
displayText string	No description
relationGuid string	No description

categoriesResult

object

Properties

data required Array<category>	No description
meta resultMeta	No description
links pageLinks	No description

createCategory

object

Properties

name string	No description
parentId string<uuid>	No description
stewards Array<string<uid>>	This list contains the uuids of the stewards of the category.
description string	No description

createGlossary

object

Properties

name required string	Name of the glossary
tags Array<string>	List of tags for glossary
spaceId string<uuid>	Unique unique identifier of the space to contain the glossary
overview string	Overview of the glossary content
description string	Description of the glossary
termTemplate termTemplate	No description

createTerm

object

Properties

name required string	No description
tags Array<string>	No description
linksTo Array<termCreateLinksTo>	No description
stewards Array<string>	This list contain the uuids for the terms stewards
relatesTo Array<termRelatesTo>	No description
categories Array<string<uuid>>	Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document.
description string	No description
abbreviation string	No description
relatedInformation string	No description

errorResponse

object

Properties

errors Array<errorResponseCode>	No description
traceId string	No description

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: application/json, application/json+qlik, application/json+atlan, application/json+atlas
BG-5 - Failed to decode JSON payload.
BG-6 - A glossary name is required.
BG-7 - Two categories with the same name cannot have the same parent.
BG-11 - Glossary validation failed - A value or parameter is invalid or not set
BG-12 - Category validation failed - A value or parameter is invalid or not set
BG-13 - Term validation failed - A value or parameter is invalid or not set
BG-14 - Two or more categories share Id
BG-15 - Two or more terms share Id
BG-16 - Not detecting proper Atlas format
BG-17 - Not detecting proper Atlan format
BG-18 - Not detecting proper Qlik format
BG-19 - Invalid format in term
BG-20 - Duplicate link definition
BG-21 - Rich text validation failed
BG-22 - Import cancelled
BG-23 - Duplicate link related

Properties

errors Array<errorResponseCode>	No description
traceId string	No description

errorResponseCode

object

Properties

code string	No description
title string	No description
detail string	No description

errorResponseForbidden

object

Custom error codes

BG-3 - Access denied, no read access

Properties

errors Array<errorResponseCode>	No description
traceId string	No description

errorResponseNotFound

object

Custom error codes

BG-8 - Glossary not found
BG-9 - Category not found
BG-10 - Term not found

Properties

errors Array<errorResponseCode>	No description
traceId string	No description

fullGlossary

object

Properties

id string<uuid>	No description
name string	No description
tags Array<string>	No description
terms Array<term>	No description
ownerId string<uuid>	No description
spaceId string<uuid>	No description
overview string	No description
createdAt string<date-time>	No description
createdBy string<uuid>	No description
updatedAt string<date-time>	No description
updatedBy string<uuid>	The uuid of the user who last updated the glossary
categories Array<category>	No description
description string	No description

glossariesResult

object

Properties

data Array<glossary>	No description
meta resultMeta	No description
links pageLinks	No description

glossary

object

Properties

id required string<uuid>	Unique identifier of the glossary
name required string	Name of the glossary
tags required Array<string>	List of tags associated with the glossary.
ownerId required string<uuid>	The unique identifier of the glossary owner
spaceId required string<uuid>	The unique identifier of the space containg the glossary
overview required string	Overview of the glossary contents
createdAt required string<date-time>	Datetime when the glossary was created
createdBy required string<uuid>	Unique identifier of the user who created the glossary
updatedAt required string<date-time>	Datetime when the glossary was updated
updatedBy required string<uuid>	The unique identifier of the user who last updated the glossary
description required string	Description of the glossary
termTemplate required termTemplate	No description

importOwner

object

Properties

name string	No description
email string	No description
userId string<uuid>	No description

importTerm

object

Properties

name string	No description
tags Array<string>	No description
owner Array<importOwner>	No description
linksTo Array<termCreateLinksTo>	No description
relatesTo Array<termRelatesTo>	No description
categories Array<string<uuid>>	Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document.
description string	No description
abbreviation string	No description

JSONPatch

object

A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.

Properties

op required string	The operation to be performed. Enum: replace
path required string	A JSON Pointer.
value required oneOf	The value to be used for this operation.

JSONPatchArray

Array<JSONPatch>

An array of JSON Patch documents

Properties

op required string	The operation to be performed. Enum: replace
path required string	A JSON Pointer.
value required oneOf	The value to be used for this operation.

linksResult

object

Properties

data Array<termLinksTo>	No description
meta resultMeta	No description
links pageLinks	No description

pageLink

object

Properties

href

string

No description

pageLinks

object

Properties

next pageLink	No description
prev pageLink	No description
self pageLink	No description

qlikGlossary

object

Properties

name string	No description
tags Array<string>	No description
terms Array<importTerm>	No description
spaceId string<uuid>	No description
overview string	No description
categories Array<createCategory>	No description
description string	No description

resultMeta

object

Properties

countTotal

integer

No description

term

object

Properties

id required string<uuid>	No description
name required string	No description
tags required Array<string>	No description
status required termStatus	Terms status is used determine the status of a term
linksTo Array<termLinksTo>	No description
revision required number	No description
stewards required Array<string>	This list contains the uuids of the terms data stewards.
createdAt required string<date-time>	No description
createdBy required string<uuid>	No description
relatesTo Array<termRelatesTo>	No description
updatedAt required string<date-time>	No description
updatedBy required string<uuid>	The uuid of the user who last updated the term
categories Array<string<uuid>>	No description
glossaryId required string<uuid>	No description
description required string	No description
abbreviation string	No description
relatedInformation required string	No description

termCreateLinksTo

object

Describes links to other data assets such as analytics applications or dataset.

Properties

type string	No description Enum: definition related
resourceId required string	No description
resourceType required string	No description Enum: app dataset
subResourceId string	No description
subResourceName string	No description
subResourceType string	No description Enum: master_dimension master_measure

termLinksTo

object

Describes links to other entities such as qlik charts, dataset columns etc.

Properties

id filterable string<uuid>	No description
name string	No description
type string	No description Enum: definition related
title string	Describes reason for item status during batch operation. E.g. why an error occurs during creation.
status number	Http status code for item during batch operation.
openUrl string	No description
createdAt string<date-time>	No description
createdBy filterable string<uuid>	No description
resourceId filterable string<uuid>	No description
resourceType filterable string	No description Enum: app dataset
subResourceId filterable string<uuid>	No description
resourceSpaceId string<uuid>	No description
subResourceName string	No description
subResourceType filterable string	No description Enum: master_dimension master_measure

termRelatesTo

object

Properties

type required string	How the term related to the other object Enum: isA hasA seeAlso synonym antonym classifies other
termId required string<uuid>	The unique identifier of the related term. NOTE! In case of import the string refers to the index of the term in the import document.

termsResult

object

Properties

data required Array<term>	No description
meta resultMeta	No description
links pageLinks	No description

termStatus

object

Terms status is used determine the status of a term

Properties

type

required

string

No description

Enum:

draft

verified

deprecated

updatedAt

required

string<date-time>

Time when the state was changed

updatedBy

required

string<uuid>

The unique identifier of the user who last changed the status of the term

termTemplate

object

Properties

relatedInformation

string

Template text for new terms

v0.809.0