Glossaries

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.

Download specification

Endpoints

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

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

countTotalboolean

Optional parameter to request total count for query
limitinteger

The number of glossaries to get.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Optional parameter to request the next page.
prevstring

Optional parameter to request the previous page.
sortstring

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

Can be one of: "name""+name""-name""description""+description""-description"

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  Unique identifier of the glossary
  
  format = "uuid"
  
  namestring
  Required
  
  Name of the glossary
  
  tagsarray of strings
  Required
  
  List of tags associated with the glossary.
  
  ownerIdstring
  Required
  
  The unique identifier of the glossary owner
  
  format = "uid"
  
  spaceIdstring
  Required
  
  The unique identifier of the space containg the glossary
  
  format = "uid"
  
  overviewstring
  Required
  
  Overview of the glossary contents
  
  createdAtstring
  Required
  
  Datetime when the glossary was created
  
  format = "date-time"
  
  createdBystring
  Required
  
  Unique identifier of the user who created the glossary
  
  format = "uid"
  
  updatedAtstring
  Required
  
  Datetime when the glossary was updated
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last updated the glossary
  
  format = "uid"
  
  descriptionstring
  Required
  
  Description of the glossary
  
  termTemplateobject
  Required
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms
- metaobject
  
  Show meta properties
  
  countTotalinteger
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show self properties
  
  hrefstring

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
  
  Show errors properties
  
  codestring
  
  titlestring
  
  detailstring
- traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

GET /v1/glossaries

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Request Body

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  
  List of tags for glossary
- spaceIdstring
  
  Unique unique identifier of the space to contain the glossary
  
  format = "uid"
- overviewstring
  
  Overview of the glossary content
- descriptionstring
  
  Description of the glossary
- termTemplateobject
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

Responses

201

application/json

Successfully created a new glossary.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  Unique identifier of the glossary
  
  format = "uuid"
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  Required
  
  List of tags associated with the glossary.
- ownerIdstring
  Required
  
  The unique identifier of the glossary owner
  
  format = "uid"
- spaceIdstring
  Required
  
  The unique identifier of the space containg the glossary
  
  format = "uid"
- overviewstring
  Required
  
  Overview of the glossary contents
- createdAtstring
  Required
  
  Datetime when the glossary was created
  
  format = "date-time"
- createdBystring
  Required
  
  Unique identifier of the user who created the glossary
  
  format = "uid"
- updatedAtstring
  Required
  
  Datetime when the glossary was updated
  
  format = "date-time"
- updatedBystring
  Required
  
  The unique identifier of the user who last updated the glossary
  
  format = "uid"
- descriptionstring
  Required
  
  Description of the glossary
- termTemplateobject
  Required
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The user does not have privileges to perform the requested action.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

POST /v1/glossaries

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}}'

const https = require('https')
  const data = JSON.stringify({"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"string","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"string"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  }
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The id of the glossary to retrieve.

format = "uuid"

Responses

200

application/json

Successfully retrieved the glossary.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  Unique identifier of the glossary
  
  format = "uuid"
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  Required
  
  List of tags associated with the glossary.
- ownerIdstring
  Required
  
  The unique identifier of the glossary owner
  
  format = "uid"
- spaceIdstring
  Required
  
  The unique identifier of the space containg the glossary
  
  format = "uid"
- overviewstring
  Required
  
  Overview of the glossary contents
- createdAtstring
  Required
  
  Datetime when the glossary was created
  
  format = "date-time"
- createdBystring
  Required
  
  Unique identifier of the user who created the glossary
  
  format = "uid"
- updatedAtstring
  Required
  
  Datetime when the glossary was updated
  
  format = "date-time"
- updatedBystring
  Required
  
  The unique identifier of the user who last updated the glossary
  
  format = "uid"
- descriptionstring
  Required
  
  Description of the glossary
- termTemplateobject
  Required
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The glossary is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

GET /v1/glossaries/{id}

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Request Body

Required

application/json

An array of JSON Patch documents

application/jsonarray of objects

An array of JSON Patch documents
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer.
- valuestring|number
  Required
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  number

Responses

204

Glossary updated successfully.

400

application/json

Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

Not authorized.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The term to patch was not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

429

application/json

Request has been rate limited.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

PATCH /v1/glossaries/{id}

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

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

idstring
Required

The id of the glossary to update.

format = "uuid"

Request Body

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  
  List of tags for glossary
- spaceIdstring
  
  Unique unique identifier of the space to contain the glossary
  
  format = "uid"
- overviewstring
  
  Overview of the glossary content
- descriptionstring
  
  Description of the glossary
- termTemplateobject
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

Responses

200

application/json

Successfully updated the glossary.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  Unique identifier of the glossary
  
  format = "uuid"
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  Required
  
  List of tags associated with the glossary.
- ownerIdstring
  Required
  
  The unique identifier of the glossary owner
  
  format = "uid"
- spaceIdstring
  Required
  
  The unique identifier of the space containg the glossary
  
  format = "uid"
- overviewstring
  Required
  
  Overview of the glossary contents
- createdAtstring
  Required
  
  Datetime when the glossary was created
  
  format = "date-time"
- createdBystring
  Required
  
  Unique identifier of the user who created the glossary
  
  format = "uid"
- updatedAtstring
  Required
  
  Datetime when the glossary was updated
  
  format = "date-time"
- updatedBystring
  Required
  
  The unique identifier of the user who last updated the glossary
  
  format = "uid"
- descriptionstring
  Required
  
  Description of the glossary
- termTemplateobject
  Required
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

PUT /v1/glossaries/{id}

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-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"}}'

const https = require('https')
  const data = JSON.stringify({"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"string","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"string"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The id of the glossary to delete.

format = "uuid"

Responses

204

Successful Operation.

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The glossary is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

DELETE /v1/glossaries/{id}

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Responses

200

application/json

Successfully exported the glossary.

application/jsonobject
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
- tagsarray of strings
- termsarray of objects
  
  Show terms properties
  
  idstring
  
  The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index
  
  namestring
  
  tagsarray of strings
  
  ownerarray of objects
  
  Show owner properties
  
  namestring
  
  emailstring
  
  userIdstring
  
  format = "uid"
  
  linksToarray of objects
  
  Describes links to other data assets such as analytics applications or dataset.
  
  Show linksTo properties
  
  typestring
  
  Can be one of: "definition""related"
  
  resourceIdstring
  Required
  
  resourceTypestring
  Required
  
  Can be one of: "app""dataset"
  
  subResourceIdstring
  
  subResourceNamestring
  
  subResourceTypestring
  
  Can be one of: "master_dimension""master_measure""field"
  
  stewardsarray of objects
  
  Show stewards properties
  
  namestring
  
  emailstring
  
  userIdstring
  
  format = "uid"
  
  relatesToarray of objects
  
  Show relatesTo properties
  
  typestring
  Required
  
  How the term related to the other object
  
  Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other"
  
  termIdstring
  Required
  
  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.
  
  format = "uuid"
  
  categoriesarray of strings
  
  Categories that the term belongs to. Refers to the id property of the category object
  
  descriptionstring
  
  abbreviationstring
  
  stewardDetailsarray of objects
- ownerIdstring
  
  format = "uid"
- spaceIdstring
  
  format = "uid"
- overviewstring
- createdAtstring
  
  format = "date-time"
- createdBystring
  
  format = "uid"
- updatedAtstring
  
  format = "date-time"
- updatedBystring
  
  The uid of the user who last updated the glossary
  
  format = "uid"
- categoriesarray of objects
  
  Show categories properties
  
  idstring
  
  The id for resolving updates in future imports/updates. Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded.
  
  namestring
  
  The name of the category. May not be identical to another category belonging to the same parent.
  
  parentIdstring
  
  format = "uuid"
  
  descriptionstring
  
  stewardDetailsarray of objects
- descriptionstring
- termTemplateobject
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The glossary is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/actions/export',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "tags": [
    "tag1",
    "tag2"
  ],
  "terms": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "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"
        }
      ],
      "stewards": [
        {
          "name": "string",
          "email": "string",
          "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      ],
      "relatesTo": [
        {
          "type": "isA",
          "termId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "description": "description",
      "abbreviation": "abbr",
      "stewardDetails": [
        {}
      ]
    }
  ],
  "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": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "description": "string",
      "stewardDetails": [
        {}
      ]
    }
  ],
  "description": "string",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

countTotalboolean

Optional parameter to request total count for query
limitinteger

The number of terms to get.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Optional parameter to request the next page.
prevstring

Optional parameter to request the previous page.
sortstring

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

Can be one of: "description""+description""-description""name""+name""-name""update""+update""-update"

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  Required
  
  format = "uuid"
  
  namestring
  Required
  
  parentIdstring
  
  format = "uuid"
  
  stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
  
  createdAtstring
  Required
  
  format = "date-time"
  
  createdBystring
  Required
  
  format = "uid"
  
  updatedAtstring
  Required
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The uid of the user who last updated the category
  
  format = "uid"
  
  glossaryIdstring
  Required
  
  format = "uuid"
  
  descriptionstring
  Required
- metaobject
  
  Show meta properties
  
  countTotalinteger
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show self properties
  
  hrefstring

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

GET /v1/glossaries/{id}/categories

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Request Body

application/json

application/jsonobject
Show application/json properties
- idstring
  
  The id for resolving updates in future imports/updates. Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded.
- namestring
  
  The name of the category. May not be identical to another category belonging to the same parent.
- parentIdstring
  
  format = "uuid"
- stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
- descriptionstring

Responses

201

application/json

Successfully created a new category.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- parentIdstring
  
  format = "uuid"
- stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the category
  
  format = "uid"
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

POST /v1/glossaries/{id}/categories

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

const https = require('https')
  const data = JSON.stringify({"id":"123e4567-e89b-12d3-a456-426614174000","name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"description":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "description": "string"
}

Response

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

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

categoryIdstring
Required

The category id.

format = "uuid"
idstring
Required

The glossary id.

format = "uuid"

Responses

200

application/json

Successfully retrieved the category.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- parentIdstring
  
  format = "uuid"
- stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the category
  
  format = "uid"
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories/{categoryId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

categoryIdstring
Required

The category id.

format = "uuid"
idstring
Required

The glossary id.

format = "uuid"

Request Body

Required

application/json

An array of JSON Patch documents

application/jsonarray of objects

An array of JSON Patch documents
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer.
- valuestring|number
  Required
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  number

Responses

204

Category updated successfully.

400

application/json

Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

Not authorized.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The term to patch was not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

429

application/json

Request has been rate limited.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories/{categoryId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

categoryIdstring
Required

The category id.

format = "uuid"
idstring
Required

The glossary id.

format = "uuid"

Request Body

application/json

application/jsonobject
Show application/json properties
- idstring
  
  The id for resolving updates in future imports/updates. Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded.
- namestring
  
  The name of the category. May not be identical to another category belonging to the same parent.
- parentIdstring
  
  format = "uuid"
- stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
- descriptionstring

Responses

200

application/json

Successfully updated the category.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- parentIdstring
  
  format = "uuid"
- stewardsarray of strings
  
  This list contains the uids of the stewards of the category.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the category
  
  format = "uid"
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify({"id":"123e4567-e89b-12d3-a456-426614174000","name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"description":"string"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories/{categoryId}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "description": "string"
}

Response

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

categoryIdstring
Required

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

format = "uuid"
idstring
Required

The id of the glossary.

format = "uuid"

Responses

204

Successful Operation.

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/categories/{categoryId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

countTotalboolean

Optional parameter to request total count for query
filterstring
Optional SCIM filter to be used to filter terms Usable fields are
- id
- name
- relatedInformation
- description
- abbreviation
- tags
- stewards
- status
- categories
limitinteger

The number of terms to get.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Optional parameter to request the next page.
prevstring

Optional parameter to request the previous page.
sortstring

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

Can be one of: "abbreviation""+abbreviation""-abbreviation""description""+description""-description""name""+name""-name""status""+status""-status""updated""+updated""-updated"

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
  
  Show data properties
  
  idstring
  Required
  
  format = "uuid"
  
  namestring
  Required
  
  tagsarray of strings
  Required
  
  statusobject
  Required
  
  Terms status is used determine the status of a term
  
  Show status properties
  
  typestring
  Required
  
  Can be one of: "draft""verified""deprecated"
  
  updatedAtstring
  Required
  
  Time when the state was changed
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last changed the status of the term
  
  format = "uid"
  
  linksToarray of objects
  
  Describes links to other entities such as qlik charts, dataset columns etc.
  
  Show linksTo properties
  
  idstring
  
  format = "uuid"
  
  namestring
  
  typestring
  
  Can be one of: "definition""related"
  
  titlestring
  
  Describes reason for item status during batch operation. E.g. why an error occurs during creation.
  
  statusnumber
  
  Http status code for item during batch operation.
  
  openUrlstring
  
  createdAtstring
  
  format = "date-time"
  
  createdBystring
  
  format = "uid"
  
  resourceIdstring
  
  Different formats based on resource type. Could be e.g. OID or UUID.
  
  resourceTypestring
  
  Can be one of: "app""dataset"
  
  subResourceIdstring
  
  Different formats based on subresource type. Could be e.g. OID or UUID.
  
  resourceSpaceIdstring
  
  format = "uid"
  
  subResourceNamestring
  
  subResourceTypestring
  
  Can be one of: "master_dimension""master_measure""field"
  
  subResourceInvalidboolean
  
  Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists.
  
  revisionnumber
  Required
  
  stewardsarray of strings
  Required
  
  This list contains the uids of the terms data stewards.
  
  createdAtstring
  Required
  
  format = "date-time"
  
  createdBystring
  Required
  
  format = "uid"
  
  relatesToarray of objects
  
  updatedAtstring
  Required
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The uid of the user who last updated the term
  
  format = "uid"
  
  categoriesarray of strings
  
  glossaryIdstring
  Required
  
  format = "uuid"
  
  descriptionstring
  Required
  
  abbreviationstring
  
  relatedInformationstring
  Required
- metaobject
  
  Show meta properties
  
  countTotalinteger
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show self properties
  
  hrefstring

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

GET /v1/glossaries/{id}/terms

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Earnings Before Interest and Tax (EBIT)",
      "tags": [
        "Finance",
        "Accounting"
      ],
      "status": {
        "type": "draft",
        "updatedAt": "2021-10-02T14:20:50.52Z",
        "updatedBy": "507f191e810c19729de860ea"
      },
      "linksTo": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "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": "123e4567-e89b-12d3-a456-426614174000",
          "resourceType": "app",
          "subResourceId": "123e4567-e89b-12d3-a456-426614174000",
          "resourceSpaceId": "507f191e810c19729de860ea",
          "subResourceName": "Sales YTD",
          "subResourceType": "master_dimension",
          "subResourceInvalid": true
        }
      ],
      "revision": 0,
      "stewards": [
        "6305e8691a1d504df06efab9",
        "63075b341a1d504df06efabc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {}
      ],
      "updatedAt": "2021-10-02T14:20:50.52Z",
      "updatedBy": "507f191e810c19729de860ea",
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000",
        "123e4567-e89b-12d3-a456-426614174001"
      ],
      "glossaryId": "123e4567-e89b-12d3-a456-426614174000",
      "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": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The glossary id.

format = "uuid"

Request Body

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
- tagsarray of strings
- linksToarray of objects
- stewardsarray of strings
  
  This list contain the uids for the term's stewards
- relatesToarray of objects
- categoriesarray of strings
  
  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.
- descriptionstring
- abbreviationstring
- relatedInformationstring

Responses

201

application/json

Successfully created a new term.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- tagsarray of strings
  Required
- statusobject
  Required
  
  Terms status is used determine the status of a term
  
  Show status properties
  
  typestring
  Required
  
  Can be one of: "draft""verified""deprecated"
  
  updatedAtstring
  Required
  
  Time when the state was changed
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last changed the status of the term
  
  format = "uid"
- linksToarray of objects
- revisionnumber
  Required
- stewardsarray of strings
  Required
  
  This list contains the uids of the terms data stewards.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- relatesToarray of objects
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the term
  
  format = "uid"
- categoriesarray of strings
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required
- abbreviationstring
- relatedInformationstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

POST /v1/glossaries/{id}/terms

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"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."}'

const https = require('https')
  const data = JSON.stringify({"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"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."})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "linksTo": [
    {}
  ],
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "relatesTo": [
    {}
  ],
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {}
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {}
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "glossaryId": "123e4567-e89b-12d3-a456-426614174000",
  "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."
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Responses

200

application/json

Successfully retrieved the term.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- tagsarray of strings
  Required
- statusobject
  Required
  
  Terms status is used determine the status of a term
  
  Show status properties
  
  typestring
  Required
  
  Can be one of: "draft""verified""deprecated"
  
  updatedAtstring
  Required
  
  Time when the state was changed
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last changed the status of the term
  
  format = "uid"
- linksToarray of objects
- revisionnumber
  Required
- stewardsarray of strings
  Required
  
  This list contains the uids of the terms data stewards.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- relatesToarray of objects
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the term
  
  format = "uid"
- categoriesarray of strings
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required
- abbreviationstring
- relatedInformationstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {}
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {}
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "glossaryId": "123e4567-e89b-12d3-a456-426614174000",
  "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."
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Request Body

Required

application/json

An array of JSON Patch documents

application/jsonarray of objects

An array of JSON Patch documents
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  A JSON Pointer.
- valuestring|number
  Required
  
  The value to be used for this operation.
  
  One of:
  
  string
  
  number

Responses

204

Term updated successfully.

400

application/json

Bad request. Payload could not be parsed to a JSON Patch or Patch operations are invalid.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

401

application/json

Not authorized.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The term to patch was not found.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

412

application/json

Conditional update failed. Trying to modify an old version.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

429

application/json

Request has been rate limited.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"name","value":"new name"},{"op":"replace","path":"description","value":"new description"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

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

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Request Body

application/json

application/jsonobject
Show application/json properties
- namestring
  Required
- tagsarray of strings
- linksToarray of objects
- stewardsarray of strings
  
  This list contain the uids for the term's stewards
- relatesToarray of objects
- categoriesarray of strings
  
  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.
- descriptionstring
- abbreviationstring
- relatedInformationstring

Responses

200

application/json

Successfully updated the term.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- tagsarray of strings
  Required
- statusobject
  Required
  
  Terms status is used determine the status of a term
  
  Show status properties
  
  typestring
  Required
  
  Can be one of: "draft""verified""deprecated"
  
  updatedAtstring
  Required
  
  Time when the state was changed
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last changed the status of the term
  
  format = "uid"
- linksToarray of objects
- revisionnumber
  Required
- stewardsarray of strings
  Required
  
  This list contains the uids of the terms data stewards.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- relatesToarray of objects
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the term
  
  format = "uid"
- categoriesarray of strings
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required
- abbreviationstring
- relatedInformationstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

412

application/json

Conditional update failed. Trying to modify an old version.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"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."}'

const https = require('https')
  const data = JSON.stringify({"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{}],"stewards":["6305e8691a1d504df06efab9","63075b341a1d504df06efabc"],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"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."})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}',
    'method': 'PUT',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "linksTo": [
    {}
  ],
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "relatesTo": [
    {}
  ],
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {}
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {}
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "glossaryId": "123e4567-e89b-12d3-a456-426614174000",
  "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."
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Responses

204

Successful Operation.

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Query Parameters

statusstring
Required

The status to update to.

Can be one of: "draft""verified""deprecated"

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Responses

200

application/json

Successfully updated the term status.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uuid"
- namestring
  Required
- tagsarray of strings
  Required
- statusobject
  Required
  
  Terms status is used determine the status of a term
  
  Show status properties
  
  typestring
  Required
  
  Can be one of: "draft""verified""deprecated"
  
  updatedAtstring
  Required
  
  Time when the state was changed
  
  format = "date-time"
  
  updatedBystring
  Required
  
  The unique identifier of the user who last changed the status of the term
  
  format = "uid"
- linksToarray of objects
- revisionnumber
  Required
- stewardsarray of strings
  Required
  
  This list contains the uids of the terms data stewards.
- createdAtstring
  Required
  
  format = "date-time"
- createdBystring
  Required
  
  format = "uid"
- relatesToarray of objects
- updatedAtstring
  Required
  
  format = "date-time"
- updatedBystring
  Required
  
  The uid of the user who last updated the term
  
  format = "uid"
- categoriesarray of strings
- glossaryIdstring
  Required
  
  format = "uuid"
- descriptionstring
  Required
- abbreviationstring
- relatedInformationstring
  Required

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

412

application/json

Conditional update failed. Trying to modify an old version.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}/actions/change-status',
    'method': 'POST',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Earnings Before Interest and Tax (EBIT)",
  "tags": [
    "Finance",
    "Accounting"
  ],
  "status": {
    "type": "draft",
    "updatedAt": "2021-10-02T14:20:50.52Z",
    "updatedBy": "507f191e810c19729de860ea"
  },
  "linksTo": [
    {}
  ],
  "revision": 0,
  "stewards": [
    "6305e8691a1d504df06efab9",
    "63075b341a1d504df06efabc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {}
  ],
  "updatedAt": "2021-10-02T14:20:50.52Z",
  "updatedBy": "507f191e810c19729de860ea",
  "categories": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "glossaryId": "123e4567-e89b-12d3-a456-426614174000",
  "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."
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

countTotalboolean

Optional parameter to request total count for query
filterstring

Optional SCIM filter to be used to filter terms
limitinteger

The number of terms to get.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Optional parameter to request the next page.
prevstring

Optional parameter to request the previous page.
sortstring

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

Can be one of: "type""+type""-type""subtype""+subtype""-subtype""created""+created""-created"

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Responses

200

application/json

Successful Operation.

application/jsonobject
Show application/json properties
- dataarray of objects
- metaobject
  
  Show meta properties
  
  countTotalinteger
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show self properties
  
  hrefstring

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}/links',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {}
  ],
  "meta": {
    "countTotal": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Header Parameters

if-matchstring

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

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Request Body

application/json

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

application/jsonobject

Describes links to other data assets such as analytics applications or dataset.
Show application/json properties
- typestring
  
  Can be one of: "definition""related"
- resourceIdstring
  Required
- resourceTypestring
  Required
  
  Can be one of: "app""dataset"
- subResourceIdstring
- subResourceNamestring
- subResourceTypestring
  
  Can be one of: "master_dimension""master_measure""field"

Responses

201

application/json

Successfully created the link.

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

application/jsonobject

Describes links to other entities such as qlik charts, dataset columns etc.
Show application/json properties
- idstring
  
  format = "uuid"
- namestring
- typestring
  
  Can be one of: "definition""related"
- titlestring
  
  Describes reason for item status during batch operation. E.g. why an error occurs during creation.
- statusnumber
  
  Http status code for item during batch operation.
- openUrlstring
- createdAtstring
  
  format = "date-time"
- createdBystring
  
  format = "uid"
- resourceIdstring
  
  Different formats based on resource type. Could be e.g. OID or UUID.
- resourceTypestring
  
  Can be one of: "app""dataset"
- subResourceIdstring
  
  Different formats based on subresource type. Could be e.g. OID or UUID.
- resourceSpaceIdstring
  
  format = "uid"
- subResourceNamestring
- subResourceTypestring
  
  Can be one of: "master_dimension""master_measure""field"
- subResourceInvalidboolean
  
  Populated and true if no matching subresource is found on parent resource. E.g. if a dataset field no longer exist but a link to that field exists.

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

412

application/json

Conditional update failed. Trying to modify an old version.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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

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

const https = require('https')
  const data = JSON.stringify({"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}/links',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

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

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "app",
  "subResourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceSpaceId": "507f191e810c19729de860ea",
  "subResourceName": "Sales YTD",
  "subResourceType": "master_dimension",
  "subResourceInvalid": true
}

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

countTotalboolean

Optional parameter to request total count for query
limitinteger

The number of terms to get.

minimum = 1, maximum = 100, default = 20, default = 20
nextstring

Optional parameter to request the next page.
prevstring

Optional parameter to request the previous page.
sortstring

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

Can be one of: "update""+update""-update"

Path Parameters

idstring
Required

The glossary id.

format = "uuid"
termIdstring
Required

The term id.

format = "uuid"

Responses

200

application/json

Successfully retrieved the revisions.

application/jsonobject
Show application/json properties
- dataarray of objects
  Required
- metaobject
  
  Show meta properties
  
  countTotalinteger
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show self properties
  
  hrefstring

400

application/json

The request is in incorrect format

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

The operation failed due to insufficient permissions.

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

The record is not found

application/jsonobject
Show application/json properties
- errorsarray of objects
- traceIdstring

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>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/{id}/terms/{termId}/revisions',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {}
  ],
  "meta": {
    "countTotal": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Query Parameters

importerAsFallbackStewardboolean

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

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

The spaceId (leave blank or omit for personal)

format = "uid"

Request Body

application/json

application/jsonobject
Show application/json properties
- namestring
- tagsarray of strings
- termsarray of objects
  
  Show terms properties
  
  idstring
  
  The id of the term. Used to identify the term in future updates. If not provided, will use the leading 30 chars of the term name and an incremental index
  
  namestring
  
  tagsarray of strings
  
  ownerarray of objects
  
  linksToarray of objects
  
  stewardsarray of objects
  
  relatesToarray of objects
  
  categoriesarray of strings
  
  Categories that the term belongs to. Refers to the id property of the category object
  
  descriptionstring
  
  abbreviationstring
  
  stewardDetailsarray of objects
- spaceIdstring
  
  format = "uid"
- overviewstring
- categoriesarray of objects
  
  Show categories properties
  
  idstring
  
  The id for resolving updates in future imports/updates. Opposed to the id of terms, id on category are not resolved by backend. Any category referred in the category array in terms will have to be identical to the id property of the category. If not, the category reference will be discarded.
  
  namestring
  
  The name of the category. May not be identical to another category belonging to the same parent.
  
  parentIdstring
  
  format = "uuid"
  
  stewardsarray of strings
  
  descriptionstring
  
  stewardDetailsarray of objects
- descriptionstring
- termTemplateobject
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

application/json+qlik

application/json+qlikobject
Show application/json+qlik properties
- namestring
- tagsarray of strings
- termsarray of objects
- spaceIdstring
  
  format = "uid"
- overviewstring
- categoriesarray of objects
- descriptionstring
- termTemplateobject
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

application/json+atlan

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

application/json+atlanobject

Atlan glossary format. See https://apidocs.atlan.com/
Show application/json+atlan properties
- entityobject
  
  Show entity properties
  
  guidstring
  
  labelsarray of strings
  
  statusstring
  
  typeNamestring
  
  attributesobject
  
  Show attributes properties
  
  guidstring
  
  namestring
  
  usagestring
  
  examplesany
  
  relationsobject
  
  Show relations properties
  
  urlstring
  
  displayNamestring
  
  displayTextstring
  
  abbreviationstring
  
  relationGuidstring
  
  parentCategorystring
  
  userDescriptionstring
  
  relationshipAttributesobject
  
  Show relationshipAttributes properties
  
  isAobject
  
  Show isA properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
  
  termsobject
  
  Show terms properties
  
  guidstring
  
  typeNamestring
  
  displayTextstring
  
  entityStatusstring
  
  seeAlsoobject
  
  Show seeAlso properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
  
  antonymsobject
  
  Show antonyms properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
  
  synonymsobject
  
  Show synonyms properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
  
  categoriesobject
  
  Show categories properties
  
  guidstring
  
  typeNamestring
  
  displayTextstring
  
  entityStatusstring
  
  classifiesobject
  
  Show classifies properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
  
  replacedByobject
  
  Show replacedBy properties
  
  guidstring
  
  stewardstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  entityStatusstring
  
  relationGuidstring
- referredEntitiesarray of objects

application/json+atlas

application/json+atlasobject
Show application/json+atlas properties
- guidstring
- namestring
- termsarray of objects
  
  Show terms properties
  
  sourcestring
  
  statusstring
  
  stewardstring
  
  termGuidstring
  
  expressionstring
  
  descriptionstring
  
  displayTextstring
  
  relationGuidstring
- usagestring
- languagestring
- categoriesarray of objects
  
  Show categories properties
  
  descriptionstring
  
  displayTextstring
  
  categoryGuidstring
  
  relationGuidstring
  
  parentCategoryGuidstring
- qualifiedNamestring
- longDescriptionstring
- shortDescriptionstring

Responses

201

application/json

Successfully created a new glossary.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  Unique identifier of the glossary
  
  format = "uuid"
- namestring
  Required
  
  Name of the glossary
- tagsarray of strings
  Required
  
  List of tags associated with the glossary.
- ownerIdstring
  Required
  
  The unique identifier of the glossary owner
  
  format = "uid"
- spaceIdstring
  Required
  
  The unique identifier of the space containg the glossary
  
  format = "uid"
- overviewstring
  Required
  
  Overview of the glossary contents
- createdAtstring
  Required
  
  Datetime when the glossary was created
  
  format = "date-time"
- createdBystring
  Required
  
  Unique identifier of the user who created the glossary
  
  format = "uid"
- updatedAtstring
  Required
  
  Datetime when the glossary was updated
  
  format = "date-time"
- updatedBystring
  Required
  
  The unique identifier of the user who last updated the glossary
  
  format = "uid"
- descriptionstring
  Required
  
  Description of the glossary
- termTemplateobject
  Required
  
  Show termTemplate properties
  
  relatedInformationstring
  
  Template text for new terms

400

application/json

See custom codes

### 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

application/jsonobject
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
Show application/json properties
- errorsarray of objects
- traceIdstring

403

application/json

See custom codes

### Custom error codes * BG-3 - Access denied, no read access

application/jsonobject
Custom error codes
- BG-3 - Access denied, no read access
Show application/json properties
- errorsarray of objects
- traceIdstring

404

application/json

See custom codes

### Custom error codes * BG-8 - Glossary not found * BG-9 - Category not found * BG-10 - Term not found

application/jsonobject
Custom error codes
- BG-8 - Glossary not found
- BG-9 - Category not found
- BG-10 - Term not found
Show application/json properties
- errorsarray of objects
- traceIdstring

POST /v1/glossaries/actions/import

curl "https://your-tenant.us.qlikcloud.com/api/v1/glossaries/actions/import" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","tags":["tag1","tag2"],"terms":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"name","tags":["tag1","tag2"],"owner":[{}],"linksTo":[{}],"stewards":[{}],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000"],"description":"description","abbreviation":"abbr","stewardDetails":[{}]}],"spaceId":"507f191e810c19729de860ea","overview":"string","categories":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["507f191e810c19729de860ea"],"description":"string","stewardDetails":[{}]}],"description":"string","termTemplate":{"relatedInformation":"string"}}'

const https = require('https')
  const data = JSON.stringify({"name":"string","tags":["tag1","tag2"],"terms":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"name","tags":["tag1","tag2"],"owner":[{}],"linksTo":[{}],"stewards":[{}],"relatesTo":[{}],"categories":["123e4567-e89b-12d3-a456-426614174000"],"description":"description","abbreviation":"abbr","stewardDetails":[{}]}],"spaceId":"507f191e810c19729de860ea","overview":"string","categories":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["507f191e810c19729de860ea"],"description":"string","stewardDetails":[{}]}],"description":"string","termTemplate":{"relatedInformation":"string"}})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/glossaries/actions/import',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <API-key>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "name": "string",
  "tags": [
    "tag1",
    "tag2"
  ],
  "terms": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "name",
      "tags": [
        "tag1",
        "tag2"
      ],
      "owner": [
        {}
      ],
      "linksTo": [
        {}
      ],
      "stewards": [
        {}
      ],
      "relatesTo": [
        {}
      ],
      "categories": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "description": "description",
      "abbreviation": "abbr",
      "stewardDetails": [
        {}
      ]
    }
  ],
  "spaceId": "507f191e810c19729de860ea",
  "overview": "string",
  "categories": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "stewards": [
        "507f191e810c19729de860ea"
      ],
      "description": "string",
      "stewardDetails": [
        {}
      ]
    }
  ],
  "description": "string",
  "termTemplate": {
    "relatedInformation": "string"
  }
}

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "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"
  }
}

Glossaries

Endpoints

Returns all glossaries.

Facts

Query Parameters

Responses

200

400

403

Response

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

Facts

Request Body

Responses

201

400

403

Request

Response

Retrieves a glossary.

Facts

Path Parameters

Responses

200

400

403

404

Response

Updates glossary properties with json-patch formated data

Facts

Header Parameters

Path Parameters

Request Body

Responses

204

400

401

403

404

429

Request

Updates a glossary.

Facts

Header Parameters

Path Parameters

Request Body

Responses

200

400

403

404

Request

Response

Deletes a glossary and all of its terms.

Facts

Path Parameters

Responses

204

400

403

404

Exports a glossary.

Facts

Path Parameters

Responses

200

400

403

404

Response

Returns a list of categories for a glossary.

Facts

Query Parameters

Path Parameters

Responses

200

400

403

404

Response