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 OpenAPI spec

Endpoints

Returns all glossaries.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • countTotal boolean

    Optional parameter to request total count for query

  • limit integer

    The number of glossaries to get.

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

  • next string

    Optional parameter to request the next page.

  • prev string

    Optional parameter to request the previous page.

  • sort string

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

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

Responses

200

Successful Operation.

  • application/json object
    Show application/json properties
    • data array of objects
      Show data properties
      • id string
        Required

        Unique identifier of the glossary

        format = "uuid"

      • name string
        Required

        Name of the glossary

      • tags array of strings
        Required

        List of tags associated with the glossary.

      • ownerId string
        Required

        The unique identifier of the glossary owner

        format = "uid"

      • spaceId string
        Required

        The unique identifier of the space containing the glossary

        format = "uid"

      • overview string
        Required

        Overview of the glossary contents. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

      • createdAt string
        Required

        Datetime when the glossary was created

        format = "date-time"

      • createdBy string
        Required

        Unique identifier of the user who created the glossary

        format = "uid"

      • updatedAt string
        Required

        Datetime when the glossary was updated

        format = "date-time"

      • updatedBy string
        Required

        The unique identifier of the user who last updated the glossary

        format = "uid"

      • description string
        Required

        Description of the glossary

      • termTemplate object
        Required
        Show termTemplate properties
        • relatedInformation string

          Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.
    • meta object
      Show meta properties
      • countTotal integer
    • links object

      URLs to a resource request

      Show links properties
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaries({})
qlik glossary ls
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Organization wide glossary",
      "tags": [
        "Red",
        "Sales"
      ],
      "ownerId": "507f191e810c19729de860ea",
      "spaceId": "507f191e810c19729de860ea",
      "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
      "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": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
      }
    }
  ],
  "meta": {
    "countTotal": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new glossary.

Only a steward can create a glossary.

Facts

Rate limit Tier 2 (100 requests per minute)

Request Body

  • application/json object
    Show application/json properties
    • name string
      Required

      Name of the glossary

    • tags array of strings

      List of tags for glossary

    • spaceId string

      Unique unique identifier of the space to contain the glossary

      format = "uid"

    • overview string

      Overview of the glossary content. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • description string

      Description of the glossary

    • termTemplate object
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

Responses

201

Successfully created a new glossary.

  • application/json object
    Show application/json properties
    • id string
      Required

      Unique identifier of the glossary

      format = "uuid"

    • name string
      Required

      Name of the glossary

    • tags array of strings
      Required

      List of tags associated with the glossary.

    • ownerId string
      Required

      The unique identifier of the glossary owner

      format = "uid"

    • spaceId string
      Required

      The unique identifier of the space containing the glossary

      format = "uid"

    • overview string
      Required

      Overview of the glossary contents. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • createdAt string
      Required

      Datetime when the glossary was created

      format = "date-time"

    • createdBy string
      Required

      Unique identifier of the user who created the glossary

      format = "uid"

    • updatedAt string
      Required

      Datetime when the glossary was updated

      format = "date-time"

    • updatedBy string
      Required

      The unique identifier of the user who last updated the glossary

      format = "uid"

    • description string
      Required

      Description of the glossary

    • termTemplate object
      Required
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.createGlossary({
  description:
    'This glossary contains definitions and concepts of business terms.',
  name: 'Organization wide glossary',
  overview:
    '[{"type":"paragraph","children":[{"text":"This glossary contains business terms"}]}]',
  spaceId: '507f191e810c19729de860ea',
  tags: ['Red', 'Sales'],
  termTemplate: {
    relatedInformation:
      '[{"type":"paragraph","children":[{"text":""}]}]',
  },
})
qlik glossary create \
  --name 'Organization wide glossary'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"}}'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
  "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": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
  }
}

Retrieves a glossary.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • id string
    Required

    The id of the glossary to retrieve.

    format = "uuid"

Responses

200

Successfully retrieved the glossary.

  • application/json object
    Show application/json properties
    • id string
      Required

      Unique identifier of the glossary

      format = "uuid"

    • name string
      Required

      Name of the glossary

    • tags array of strings
      Required

      List of tags associated with the glossary.

    • ownerId string
      Required

      The unique identifier of the glossary owner

      format = "uid"

    • spaceId string
      Required

      The unique identifier of the space containing the glossary

      format = "uid"

    • overview string
      Required

      Overview of the glossary contents. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • createdAt string
      Required

      Datetime when the glossary was created

      format = "date-time"

    • createdBy string
      Required

      Unique identifier of the user who created the glossary

      format = "uid"

    • updatedAt string
      Required

      Datetime when the glossary was updated

      format = "date-time"

    • updatedBy string
      Required

      The unique identifier of the user who last updated the glossary

      format = "uid"

    • description string
      Required

      Description of the glossary

    • termTemplate object
      Required
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The glossary is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossary(
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary get '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
  "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": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
  }
}

Updates glossary properties with json-patch formatted data.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Request Body

Required
  • application/json array of objects

    An array of JSON Patch documents

    Show application/json properties
    • op string
      Required

      The operation to be performed.

      Can be one of: "replace"

    • path string
      Required

      A JSON Pointer.

    • value string|number
      Required

      The value to be used for this operation.

      One of:
      • string
      • number

Responses

204

Glossary updated successfully.

400

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

401

Not authorized.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The term to patch was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

429

Request has been rate limited.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PATCH /api/v1/glossaries/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.patchGlossary(
  '123e4567-e89b-12d3-a456-426614174000',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'new name',
    },


    {
      op: 'replace',
      path: '/description',
      value: 'new description',
    },
  ],
)
qlik glossary patch '123e4567-e89b-12d3-a456-426614174000' \
  --op 'replace' \
  --path '/name' \
  --value new name
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"}]'

Updates a glossary.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • id string
    Required

    The id of the glossary to update.

    format = "uuid"

Request Body

  • application/json object
    Show application/json properties
    • name string
      Required

      Name of the glossary

    • tags array of strings

      List of tags for glossary

    • spaceId string

      Unique unique identifier of the space to contain the glossary

      format = "uid"

    • overview string

      Overview of the glossary content. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • description string

      Description of the glossary

    • termTemplate object
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

Responses

200

Successfully updated the glossary.

  • application/json object
    Show application/json properties
    • id string
      Required

      Unique identifier of the glossary

      format = "uuid"

    • name string
      Required

      Name of the glossary

    • tags array of strings
      Required

      List of tags associated with the glossary.

    • ownerId string
      Required

      The unique identifier of the glossary owner

      format = "uid"

    • spaceId string
      Required

      The unique identifier of the space containing the glossary

      format = "uid"

    • overview string
      Required

      Overview of the glossary contents. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • createdAt string
      Required

      Datetime when the glossary was created

      format = "date-time"

    • createdBy string
      Required

      Unique identifier of the user who created the glossary

      format = "uid"

    • updatedAt string
      Required

      Datetime when the glossary was updated

      format = "date-time"

    • updatedBy string
      Required

      The unique identifier of the user who last updated the glossary

      format = "uid"

    • description string
      Required

      Description of the glossary

    • termTemplate object
      Required
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PUT /api/v1/glossaries/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.updateGlossary(
  '123e4567-e89b-12d3-a456-426614174000',
  {
    description:
      'This glossary contains definitions and concepts of business terms.',
    name: 'Organization wide glossary',
    overview:
      '[{"type":"paragraph","children":[{"text":"This glossary contains business terms"}]}]',
    spaceId: '507f191e810c19729de860ea',
    tags: ['Red', 'Sales'],
    termTemplate: {
      relatedInformation:
        '[{"type":"paragraph","children":[{"text":""}]}]',
    },
  },
)
qlik glossary update '123e4567-e89b-12d3-a456-426614174000' \
  --name 'Organization wide glossary'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Organization wide glossary","tags":["Red","Sales"],"spaceId":"507f191e810c19729de860ea","overview":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]","description":"This glossary contains definitions and concepts of business terms.","termTemplate":{"relatedInformation":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"}}'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
  "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": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
  }
}

Deletes a glossary and all of its terms.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • id string
    Required

    The id of the glossary to delete.

    format = "uuid"

Responses

204

Successful Operation.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The glossary is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
DELETE /api/v1/glossaries/{id} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.deleteGlossary(
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary rm '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Exports a glossary.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • format string

    The output format

    Can be one of: "json""xlsx"

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Responses

200

Successfully exported the glossary.

  • application/json object
    Show application/json properties
    • id string

      format = "uuid"

    • name string
    • tags array of strings
    • terms array of objects
      Show terms properties
      • id string

        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

      • name string
      • tags array of strings
      • owner array of objects
        Show owner properties
        • name string
        • email string
        • userId string

          format = "uid"

      • linksTo array of objects

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

        Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

        Show linksTo properties
        • type string

          The type of relationship between the term and the linked resource:

          • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
          • related: Use when the term is generally related to the resource but doesn't formally define it

          Can be one of: "definition""related"

        • resourceId string
          Required

          The unique identifier of the resource (app or dataset) to link to the term.

        • resourceType string
          Required

          The type of resource being linked to the term.

          Can be one of: "app""dataset"

        • subResourceId string

          Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

        • subResourceName string

          Required when subResourceType or subResourceId is provided. The display name of the subresource.

        • subResourceType string

          Required when subResourceId or subResourceName is provided. The type of the subresource.

          Can be one of: "master_dimension""master_measure""field"

      • stewards array of objects
        Show stewards properties
        • name string
        • email string
        • userId string

          format = "uid"

      • relatesTo array of objects
        Show relatesTo properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • categories array of strings

        Categories that the term belongs to. Refers to the id property of the category object

      • description string
      • abbreviation string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • ownerId string

      format = "uid"

    • spaceId string

      format = "uid"

    • overview string

      Overview of the glossary. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • createdAt string

      format = "date-time"

    • createdBy string

      format = "uid"

    • updatedAt string

      format = "date-time"

    • updatedBy string

      The uid of the user who last updated the glossary

      format = "uid"

    • categories array of objects
      Show categories properties
      • id string

        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.

      • name string

        The name of the category. May not be identical to another category belonging to the same parent.

      • parentId string

        format = "uuid"

      • description string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • description string
    • termTemplate object
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

200

Successfully exported the glossary.

  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet string

    format = "binary"

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The glossary is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/actions/export 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.exportGlossary(
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary export '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/actions/export" \
-H "Authorization: Bearer <access_token>"

Example 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": [
        {
          "name": "string",
          "email": "string",
          "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      ]
    }
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
  "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": [
        {
          "name": "string",
          "email": "string",
          "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
        }
      ]
    }
  ],
  "description": "string",
  "termTemplate": {
    "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
  }
}

Returns a list of categories for a glossary.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • countTotal boolean

    Optional parameter to request total count for query

  • limit integer

    The number of terms to get.

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

  • next string

    Optional parameter to request the next page.

  • prev string

    Optional parameter to request the previous page.

  • sort string

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

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Responses

200

Successful Operation.

  • application/json object
    Show application/json properties
    • data array of objects
      Required
      Show data properties
      • id string
        Required

        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.

        format = "uuid"

      • name string
        Required
      • parentId string

        format = "uuid"

      • stewards array of strings

        This list contains the UIDs of the stewards of the category.

      • createdAt string
        Required

        format = "date-time"

      • createdBy string
        Required

        format = "uid"

      • updatedAt string
        Required

        format = "date-time"

      • updatedBy string
        Required

        The uid of the user who last updated the category

        format = "uid"

      • glossaryId string
        Required

        format = "uuid"

      • description string
        Required
    • meta object
      Show meta properties
      • countTotal integer
    • links object

      URLs to a resource request

      Show links properties
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/categories 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryCategories(
  '123e4567-e89b-12d3-a456-426614174000',
  {},
)
qlik glossary category ls \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "string",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "stewards": [
        "6305e8691a1d504df06e2ab9",
        "63075b341a1d504df06e2abc"
      ],
      "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"
    }
  }
}

Creates a new category.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Request Body

  • application/json object
    Show application/json properties
    • name string

      The name of the category. May not be identical to another category belonging to the same parent.

    • parentId string

      format = "uuid"

    • stewards array of strings

      This list contains the UIDs of the stewards of the category.

    • description string

Responses

201

Successfully created a new category.

  • application/json object
    Show application/json properties
    • id string
      Required

      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.

      format = "uuid"

    • name string
      Required
    • parentId string

      format = "uuid"

    • stewards array of strings

      This list contains the UIDs of the stewards of the category.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the category

      format = "uid"

    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries/{id}/categories 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.createGlossaryCategory(
  '123e4567-e89b-12d3-a456-426614174000',
  {
    description: 'string',
    name: 'string',
    parentId:
      '123e4567-e89b-12d3-a456-426614174000',
    stewards: [
      '6305e8691a1d504df06e2ab9',


      '63075b341a1d504df06e2abc',
    ],
  },
)
qlik glossary category create \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["6305e8691a1d504df06e2ab9","63075b341a1d504df06e2abc"],"description":"string"}'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "stewards": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "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"
}

Retrieves a category.

Facts

Rate limit Tier 1 (1000 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • categoryId string
    Required

    The category id.

    format = "uuid"

  • id string
    Required

    The glossary id.

    format = "uuid"

Responses

200

Successfully retrieved the category.

  • application/json object
    Show application/json properties
    • id string
      Required

      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.

      format = "uuid"

    • name string
      Required
    • parentId string

      format = "uuid"

    • stewards array of strings

      This list contains the UIDs of the stewards of the category.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the category

      format = "uid"

    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/categories/{categoryId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryCategory(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary category get '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "stewards": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "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"
}

Updates category properties with json-patch formatted data.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • categoryId string
    Required

    The category id.

    format = "uuid"

  • id string
    Required

    The glossary id.

    format = "uuid"

Request Body

Required
  • application/json array of objects

    An array of JSON Patch documents

    Show application/json properties
    • op string
      Required

      The operation to be performed.

      Can be one of: "replace"

    • path string
      Required

      A JSON Pointer.

    • value string|number
      Required

      The value to be used for this operation.

      One of:
      • string
      • number

Responses

204

Category updated successfully.

400

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

401

Not authorized.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The term to patch was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

429

Request has been rate limited.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PATCH /api/v1/glossaries/{id}/categories/{categoryId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.patchGlossaryCategory(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'new name',
    },


    {
      op: 'replace',
      path: '/description',
      value: 'new description',
    },
  ],
)
qlik glossary category patch '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --op 'replace' \
  --path '/name' \
  --value new name
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"}]'

Updates a category.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • categoryId string
    Required

    The category id.

    format = "uuid"

  • id string
    Required

    The glossary id.

    format = "uuid"

Request Body

  • application/json object
    Show application/json properties
    • name string

      The name of the category. May not be identical to another category belonging to the same parent.

    • parentId string

      format = "uuid"

    • stewards array of strings

      This list contains the UIDs of the stewards of the category.

    • description string

Responses

200

Successfully updated the category.

  • application/json object
    Show application/json properties
    • id string
      Required

      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.

      format = "uuid"

    • name string
      Required
    • parentId string

      format = "uuid"

    • stewards array of strings

      This list contains the UIDs of the stewards of the category.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the category

      format = "uid"

    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PUT /api/v1/glossaries/{id}/categories/{categoryId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.updateGlossaryCategory(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  {
    description: 'string',
    name: 'string',
    parentId:
      '123e4567-e89b-12d3-a456-426614174000',
    stewards: [
      '6305e8691a1d504df06e2ab9',


      '63075b341a1d504df06e2abc',
    ],
  },
)
qlik glossary category update '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["6305e8691a1d504df06e2ab9","63075b341a1d504df06e2abc"],"description":"string"}'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "string",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "stewards": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "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"
}

Deletes a category.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • categoryId string
    Required

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

    format = "uuid"

  • id string
    Required

    The id of the glossary.

    format = "uuid"

Responses

204

Successful Operation.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
DELETE /api/v1/glossaries/{id}/categories/{categoryId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.deleteGlossaryCategory(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary category rm '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Returns a list of terms for a glossary.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • countTotal boolean

    Optional parameter to request total count for query

  • filter string

    Optional SCIM filter to be used to filter terms Usable fields are

    • id
    • name
    • relatedInformation
    • description
    • abbreviation
    • tags
    • stewards
    • status
    • categories
  • limit integer

    The number of terms to get.

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

  • next string

    Optional parameter to request the next page.

  • prev string

    Optional parameter to request the previous page.

  • sort string

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

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Responses

200

Successful Operation.

  • application/json object
    Show application/json properties
    • data array of objects
      Required
      Show data properties
      • id string
        Required

        format = "uuid"

      • name string
        Required
      • tags array of strings
        Required
      • status object
        Required Filterable

        Terms status is used determine the status of a term

        Show status properties
        • type string
          Required

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

        • updatedAt string
          Required

          Time when the state was changed

          format = "date-time"

        • updatedBy string
          Required

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

          format = "uid"

      • linksTo array of objects

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

        Show linksTo properties
        • id string

          format = "uuid"

        • name string
        • type string

          Can be one of: "definition""related"

        • title string

          Describes reason for item status during batch operation. E.g. why an error occurs during creation.

        • status number

          Http status code for item during batch operation.

        • openUrl string
        • createdAt string

          format = "date-time"

        • createdBy string

          format = "uid"

        • resourceId string

          Different formats based on resource type. Could be e.g. OID or UUID.

        • resourceType string

          Can be one of: "app""dataset"

        • subResourceId string

          Different formats based on subresource type. Could be e.g. OID or UUID.

        • resourceSpaceId string

          format = "uid"

        • subResourceName string
        • subResourceType string

          Can be one of: "master_dimension""master_measure""field"

        • subResourceInvalid boolean

          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.
      • revision number
        Required
      • stewards array of strings
        Required

        This list contains the UIDs of the terms data stewards.

      • createdAt string
        Required

        format = "date-time"

      • createdBy string
        Required

        format = "uid"

      • relatesTo array of objects

        Term relations assigned to this term.

        Show relatesTo properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • updatedAt string
        Required

        format = "date-time"

      • updatedBy string
        Required

        The uid of the user who last updated the term

        format = "uid"

      • categories array of strings
      • glossaryId string
        Required

        format = "uuid"

      • description string
        Required
      • abbreviation string
        Required
      • referredRelations array of objects

        Term relations where this term is the target of the relation.

        Show referredRelations properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • relatedInformation string
        Required

        Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.
    • meta object
      Show meta properties
      • countTotal integer
    • links object

      URLs to a resource request

      Show links properties
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/terms 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryTerms(
  '123e4567-e89b-12d3-a456-426614174000',
  {},
)
qlik glossary term ls \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms" \
-H "Authorization: Bearer <access_token>"

Example 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": [
        "6305e8691a1d504df06e2ab9",
        "63075b341a1d504df06e2abc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {
          "type": "isA",
          "termId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "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",
      "referredRelations": [
        {
          "type": "isA",
          "termId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"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"
    }
  }
}

Creates a new term.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

Request Body

  • application/json object
    Show application/json properties
    • name string
      Required
    • tags array of strings
    • linksTo array of objects

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

      Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

      Show linksTo properties
      • type string

        The type of relationship between the term and the linked resource:

        • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
        • related: Use when the term is generally related to the resource but doesn't formally define it

        Can be one of: "definition""related"

      • resourceId string
        Required

        The unique identifier of the resource (app or dataset) to link to the term.

      • resourceType string
        Required

        The type of resource being linked to the term.

        Can be one of: "app""dataset"

      • subResourceId string

        Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

      • subResourceName string

        Required when subResourceType or subResourceId is provided. The display name of the subresource.

      • subResourceType string

        Required when subResourceId or subResourceName is provided. The type of the subresource.

        Can be one of: "master_dimension""master_measure""field"

    • stewards array of strings

      This list contain the UIDs for the term's stewards

    • relatesTo array of objects
      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • categories array 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.

    • description string
    • abbreviation string
    • relatedInformation string

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

Responses

201

Successfully created a new term.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uuid"

    • name string
      Required
    • tags array of strings
      Required
    • status object
      Required Filterable

      Terms status is used determine the status of a term

      Show status properties
      • type string
        Required

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

      • updatedAt string
        Required

        Time when the state was changed

        format = "date-time"

      • updatedBy string
        Required

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

        format = "uid"

    • linksTo array of objects

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

      Show linksTo properties
      • id string

        format = "uuid"

      • name string
      • type string

        Can be one of: "definition""related"

      • title string

        Describes reason for item status during batch operation. E.g. why an error occurs during creation.

      • status number

        Http status code for item during batch operation.

      • openUrl string
      • createdAt string

        format = "date-time"

      • createdBy string

        format = "uid"

      • resourceId string

        Different formats based on resource type. Could be e.g. OID or UUID.

      • resourceType string

        Can be one of: "app""dataset"

      • subResourceId string

        Different formats based on subresource type. Could be e.g. OID or UUID.

      • resourceSpaceId string

        format = "uid"

      • subResourceName string
      • subResourceType string

        Can be one of: "master_dimension""master_measure""field"

      • subResourceInvalid boolean

        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.
    • revision number
      Required
    • stewards array of strings
      Required

      This list contains the UIDs of the terms data stewards.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • relatesTo array of objects

      Term relations assigned to this term.

      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the term

      format = "uid"

    • categories array of strings
    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required
    • abbreviation string
      Required
    • referredRelations array of objects

      Term relations where this term is the target of the relation.

      Show referredRelations properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • relatedInformation string
      Required

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries/{id}/terms 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.createGlossaryTerm(
  '123e4567-e89b-12d3-a456-426614174000',
  {
    abbreviation: 'EBIT',
    categories: [
      '123e4567-e89b-12d3-a456-426614174000',


      '123e4567-e89b-12d3-a456-426614174001',
    ],
    description: 'string',
    linksTo: [
      {
        resourceId: 'string',
        resourceType: 'app',
        subResourceId: 'string',
        subResourceName: 'string',
        subResourceType: 'master_dimension',
        type: 'definition',
      },
    ],
    name: 'Earnings Before Interest and Tax (EBIT)',
    relatedInformation:
      '[{"type":"paragraph","children":[{"text":"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."}]}]',
    relatesTo: [
      {
        termId:
          '123e4567-e89b-12d3-a456-426614174000',
        type: 'isA',
      },
    ],
    stewards: [
      '6305e8691a1d504df06e2ab9',


      '63075b341a1d504df06ef2bc',
    ],
    tags: ['Finance', 'Accounting'],
  },
)
qlik glossary term create \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --linksTo-resourceId '' \
  --linksTo-resourceType '' \
  --name 'Earnings Before Interest and Tax (EBIT)' \
  --relatesTo-termId '' \
  --relatesTo-type ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}],"stewards":["6305e8691a1d504df06e2ab9","63075b341a1d504df06ef2bc"],"relatesTo":[{"type":"isA","termId":"123e4567-e89b-12d3-a456-426614174000"}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"description":"string","abbreviation":"EBIT","relatedInformation":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"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.\"}]}]"}'

Example 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": [
    {
      "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": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "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",
  "referredRelations": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses.\"}]}]"
}

Retrieves a term.

Facts

Rate limit Tier 1 (1000 requests per minute)

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Responses

200

Successfully retrieved the term.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uuid"

    • name string
      Required
    • tags array of strings
      Required
    • status object
      Required Filterable

      Terms status is used determine the status of a term

      Show status properties
      • type string
        Required

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

      • updatedAt string
        Required

        Time when the state was changed

        format = "date-time"

      • updatedBy string
        Required

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

        format = "uid"

    • linksTo array of objects

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

      Show linksTo properties
      • id string

        format = "uuid"

      • name string
      • type string

        Can be one of: "definition""related"

      • title string

        Describes reason for item status during batch operation. E.g. why an error occurs during creation.

      • status number

        Http status code for item during batch operation.

      • openUrl string
      • createdAt string

        format = "date-time"

      • createdBy string

        format = "uid"

      • resourceId string

        Different formats based on resource type. Could be e.g. OID or UUID.

      • resourceType string

        Can be one of: "app""dataset"

      • subResourceId string

        Different formats based on subresource type. Could be e.g. OID or UUID.

      • resourceSpaceId string

        format = "uid"

      • subResourceName string
      • subResourceType string

        Can be one of: "master_dimension""master_measure""field"

      • subResourceInvalid boolean

        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.
    • revision number
      Required
    • stewards array of strings
      Required

      This list contains the UIDs of the terms data stewards.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • relatesTo array of objects

      Term relations assigned to this term.

      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the term

      format = "uid"

    • categories array of strings
    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required
    • abbreviation string
      Required
    • referredRelations array of objects

      Term relations where this term is the target of the relation.

      Show referredRelations properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • relatedInformation string
      Required

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/terms/{termId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryTerm(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary term get '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-H "Authorization: Bearer <access_token>"

Example 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": [
    {
      "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": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "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",
  "referredRelations": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses.\"}]}]"
}

Updates term properties with json-patch formatted data

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Request Body

Required
  • application/json array of objects

    An array of JSON Patch documents

    Show application/json properties
    • op string
      Required

      The operation to be performed.

      Can be one of: "replace"

    • path string
      Required

      A JSON Pointer.

    • value string|number
      Required

      The value to be used for this operation.

      One of:
      • string
      • number

Responses

204

Term updated successfully.

400

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

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

401

Not authorized.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The term to patch was not found.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

412

Conditional update failed. Trying to modify an old version.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

429

Request has been rate limited.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PATCH /api/v1/glossaries/{id}/terms/{termId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.patchGlossaryTerm(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  [
    {
      op: 'replace',
      path: '/name',
      value: 'new name',
    },


    {
      op: 'replace',
      path: '/description',
      value: 'new description',
    },
  ],
)
qlik glossary term patch '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --op 'replace' \
  --path '/name' \
  --value new name
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/name","value":"new name"},{"op":"replace","path":"/description","value":"new description"}]'

Updates a term.

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Request Body

  • application/json object
    Show application/json properties
    • name string
      Required
    • tags array of strings
    • linksTo array of objects

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

      Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

      Show linksTo properties
      • type string

        The type of relationship between the term and the linked resource:

        • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
        • related: Use when the term is generally related to the resource but doesn't formally define it

        Can be one of: "definition""related"

      • resourceId string
        Required

        The unique identifier of the resource (app or dataset) to link to the term.

      • resourceType string
        Required

        The type of resource being linked to the term.

        Can be one of: "app""dataset"

      • subResourceId string

        Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

      • subResourceName string

        Required when subResourceType or subResourceId is provided. The display name of the subresource.

      • subResourceType string

        Required when subResourceId or subResourceName is provided. The type of the subresource.

        Can be one of: "master_dimension""master_measure""field"

    • stewards array of strings

      This list contain the UIDs for the term's stewards

    • relatesTo array of objects
      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • categories array 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.

    • description string
    • abbreviation string
    • relatedInformation string

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

Responses

200

Successfully updated the term.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uuid"

    • name string
      Required
    • tags array of strings
      Required
    • status object
      Required Filterable

      Terms status is used determine the status of a term

      Show status properties
      • type string
        Required

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

      • updatedAt string
        Required

        Time when the state was changed

        format = "date-time"

      • updatedBy string
        Required

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

        format = "uid"

    • linksTo array of objects

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

      Show linksTo properties
      • id string

        format = "uuid"

      • name string
      • type string

        Can be one of: "definition""related"

      • title string

        Describes reason for item status during batch operation. E.g. why an error occurs during creation.

      • status number

        Http status code for item during batch operation.

      • openUrl string
      • createdAt string

        format = "date-time"

      • createdBy string

        format = "uid"

      • resourceId string

        Different formats based on resource type. Could be e.g. OID or UUID.

      • resourceType string

        Can be one of: "app""dataset"

      • subResourceId string

        Different formats based on subresource type. Could be e.g. OID or UUID.

      • resourceSpaceId string

        format = "uid"

      • subResourceName string
      • subResourceType string

        Can be one of: "master_dimension""master_measure""field"

      • subResourceInvalid boolean

        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.
    • revision number
      Required
    • stewards array of strings
      Required

      This list contains the UIDs of the terms data stewards.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • relatesTo array of objects

      Term relations assigned to this term.

      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the term

      format = "uid"

    • categories array of strings
    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required
    • abbreviation string
      Required
    • referredRelations array of objects

      Term relations where this term is the target of the relation.

      Show referredRelations properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • relatedInformation string
      Required

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

412

Conditional update failed. Trying to modify an old version.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
PUT /api/v1/glossaries/{id}/terms/{termId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.updateGlossaryTerm(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  {
    abbreviation: 'EBIT',
    categories: [
      '123e4567-e89b-12d3-a456-426614174000',


      '123e4567-e89b-12d3-a456-426614174001',
    ],
    description: 'string',
    linksTo: [
      {
        resourceId: 'string',
        resourceType: 'app',
        subResourceId: 'string',
        subResourceName: 'string',
        subResourceType: 'master_dimension',
        type: 'definition',
      },
    ],
    name: 'Earnings Before Interest and Tax (EBIT)',
    relatedInformation:
      '[{"type":"paragraph","children":[{"text":"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."}]}]',
    relatesTo: [
      {
        termId:
          '123e4567-e89b-12d3-a456-426614174000',
        type: 'isA',
      },
    ],
    stewards: [
      '6305e8691a1d504df06e2ab9',


      '63075b341a1d504df06ef2bc',
    ],
    tags: ['Finance', 'Accounting'],
  },
)
qlik glossary term update '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --linksTo-resourceId '' \
  --linksTo-resourceType '' \
  --name 'Earnings Before Interest and Tax (EBIT)' \
  --relatesTo-termId '' \
  --relatesTo-type ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Earnings Before Interest and Tax (EBIT)","tags":["Finance","Accounting"],"linksTo":[{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}],"stewards":["6305e8691a1d504df06e2ab9","63075b341a1d504df06ef2bc"],"relatesTo":[{"type":"isA","termId":"123e4567-e89b-12d3-a456-426614174000"}],"categories":["123e4567-e89b-12d3-a456-426614174000","123e4567-e89b-12d3-a456-426614174001"],"description":"string","abbreviation":"EBIT","relatedInformation":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"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.\"}]}]"}'

Example 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": [
    {
      "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": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "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",
  "referredRelations": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"In accounting and finance, earnings before interest and taxes (EBIT) is a measure of a firm's profit that includes all incomes and expenses (operating and non-operating) except interest expenses and income tax expenses.\"}]}]"
}

Deletes a term.

Facts

Rate limit Tier 2 (100 requests per minute)

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Responses

204

Successful Operation.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
DELETE /api/v1/glossaries/{id}/terms/{termId} 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.deleteGlossaryTerm(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
)
qlik glossary term rm '123e4567-e89b-12d3-a456-426614174000' \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

Changes the status of the term.

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

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Query Parameters

  • status string
    Required

    The status to update to.

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Responses

200

Successfully updated the term status.

  • application/json object
    Show application/json properties
    • id string
      Required

      format = "uuid"

    • name string
      Required
    • tags array of strings
      Required
    • status object
      Required Filterable

      Terms status is used determine the status of a term

      Show status properties
      • type string
        Required

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

      • updatedAt string
        Required

        Time when the state was changed

        format = "date-time"

      • updatedBy string
        Required

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

        format = "uid"

    • linksTo array of objects

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

      Show linksTo properties
      • id string

        format = "uuid"

      • name string
      • type string

        Can be one of: "definition""related"

      • title string

        Describes reason for item status during batch operation. E.g. why an error occurs during creation.

      • status number

        Http status code for item during batch operation.

      • openUrl string
      • createdAt string

        format = "date-time"

      • createdBy string

        format = "uid"

      • resourceId string

        Different formats based on resource type. Could be e.g. OID or UUID.

      • resourceType string

        Can be one of: "app""dataset"

      • subResourceId string

        Different formats based on subresource type. Could be e.g. OID or UUID.

      • resourceSpaceId string

        format = "uid"

      • subResourceName string
      • subResourceType string

        Can be one of: "master_dimension""master_measure""field"

      • subResourceInvalid boolean

        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.
    • revision number
      Required
    • stewards array of strings
      Required

      This list contains the UIDs of the terms data stewards.

    • createdAt string
      Required

      format = "date-time"

    • createdBy string
      Required

      format = "uid"

    • relatesTo array of objects

      Term relations assigned to this term.

      Show relatesTo properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • updatedAt string
      Required

      format = "date-time"

    • updatedBy string
      Required

      The uid of the user who last updated the term

      format = "uid"

    • categories array of strings
    • glossaryId string
      Required

      format = "uuid"

    • description string
      Required
    • abbreviation string
      Required
    • referredRelations array of objects

      Term relations where this term is the target of the relation.

      Show referredRelations properties
      • type string
        Required

        How the term related to the other object

        Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

      • termId string
        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"

    • relatedInformation string
      Required

      Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

412

Conditional update failed. Trying to modify an old version.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries/{id}/terms/{termId}/actions/change-status 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.changeGlossaryTermStatus(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  { status: 'draft' },
)
qlik glossary term change-status \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --termId '123e4567-e89b-12d3-a456-426614174000' \
  --status 'draft'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/actions/change-status" \
-X POST \
-H "Authorization: Bearer <access_token>"

Example 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": [
    {
      "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": [
    "6305e8691a1d504df06e2ab9",
    "63075b341a1d504df06e2abc"
  ],
  "createdAt": "2021-10-02T14:20:50.52Z",
  "createdBy": "507f191e810c19729de860ea",
  "relatesTo": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "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",
  "referredRelations": [
    {
      "type": "isA",
      "termId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"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)

Query Parameters

  • countTotal boolean

    Optional parameter to request total count for query

  • filter string

    Optional SCIM filter to be used to filter terms

  • limit integer

    The number of terms to get.

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

  • next string

    Optional parameter to request the next page.

  • prev string

    Optional parameter to request the previous page.

  • sort string

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

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Responses

200

Successful Operation.

  • application/json object
    Show application/json properties
    • data array of objects

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

      Show data properties
      • id string

        format = "uuid"

      • name string
      • type string

        Can be one of: "definition""related"

      • title string

        Describes reason for item status during batch operation. E.g. why an error occurs during creation.

      • status number

        Http status code for item during batch operation.

      • openUrl string
      • createdAt string

        format = "date-time"

      • createdBy string

        format = "uid"

      • resourceId string

        Different formats based on resource type. Could be e.g. OID or UUID.

      • resourceType string

        Can be one of: "app""dataset"

      • subResourceId string

        Different formats based on subresource type. Could be e.g. OID or UUID.

      • resourceSpaceId string

        format = "uid"

      • subResourceName string
      • subResourceType string

        Can be one of: "master_dimension""master_measure""field"

      • subResourceInvalid boolean

        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.
    • meta object
      Show meta properties
      • countTotal integer
    • links object

      URLs to a resource request

      Show links properties
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/terms/{termId}/links 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryTermLinks(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  {},
)
qlik glossary term link ls \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --termId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/links" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "data": [
    {
      "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
    }
  ],
  "meta": {
    "countTotal": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a new link to a term.

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

Facts

Rate limit Tier 2 (100 requests per minute)

Header Parameters

  • if-match string

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Request Body

  • application/json object

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

    Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

    Show application/json properties
    • type string

      The type of relationship between the term and the linked resource:

      • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
      • related: Use when the term is generally related to the resource but doesn't formally define it

      Can be one of: "definition""related"

    • resourceId string
      Required

      The unique identifier of the resource (app or dataset) to link to the term.

    • resourceType string
      Required

      The type of resource being linked to the term.

      Can be one of: "app""dataset"

    • subResourceId string

      Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

    • subResourceName string

      Required when subResourceType or subResourceId is provided. The display name of the subresource.

    • subResourceType string

      Required when subResourceId or subResourceName is provided. The type of the subresource.

      Can be one of: "master_dimension""master_measure""field"

Responses

201

Successfully created the link.

  • application/json object

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

    Show application/json properties
    • id string

      format = "uuid"

    • name string
    • type string

      Can be one of: "definition""related"

    • title string

      Describes reason for item status during batch operation. E.g. why an error occurs during creation.

    • status number

      Http status code for item during batch operation.

    • openUrl string
    • createdAt string

      format = "date-time"

    • createdBy string

      format = "uid"

    • resourceId string

      Different formats based on resource type. Could be e.g. OID or UUID.

    • resourceType string

      Can be one of: "app""dataset"

    • subResourceId string

      Different formats based on subresource type. Could be e.g. OID or UUID.

    • resourceSpaceId string

      format = "uid"

    • subResourceName string
    • subResourceType string

      Can be one of: "master_dimension""master_measure""field"

    • subResourceInvalid boolean

      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

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

412

Conditional update failed. Trying to modify an old version.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries/{id}/terms/{termId}/links 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.createGlossaryTermLink(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  {
    resourceId: 'string',
    resourceType: 'app',
    subResourceId: 'string',
    subResourceName: 'string',
    subResourceType: 'master_dimension',
    type: 'definition',
  },
)
qlik glossary term link create \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --termId '123e4567-e89b-12d3-a456-426614174000' \
  --resourceId 'string' \
  --resourceType 'app'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/links" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"definition","resourceId":"string","resourceType":"app","subResourceId":"string","subResourceName":"string","subResourceType":"master_dimension"}'

Example 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
}

Retrieves previous revisions of a term.

Facts

Rate limit Tier 1 (1000 requests per minute)

Query Parameters

  • countTotal boolean

    Optional parameter to request total count for query

  • limit integer

    The number of terms to get.

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

  • next string

    Optional parameter to request the next page.

  • prev string

    Optional parameter to request the previous page.

  • sort string

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

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

Path Parameters

  • id string
    Required

    The glossary id.

    format = "uuid"

  • termId string
    Required

    The term id.

    format = "uuid"

Responses

200

Successfully retrieved the revisions.

  • application/json object
    Show application/json properties
    • data array of objects
      Required
      Show data properties
      • id string
        Required

        format = "uuid"

      • name string
        Required
      • tags array of strings
        Required
      • status object
        Required Filterable

        Terms status is used determine the status of a term

        Show status properties
        • type string
          Required

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

        • updatedAt string
          Required

          Time when the state was changed

          format = "date-time"

        • updatedBy string
          Required

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

          format = "uid"

      • linksTo array of objects

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

        Show linksTo properties
        • id string

          format = "uuid"

        • name string
        • type string

          Can be one of: "definition""related"

        • title string

          Describes reason for item status during batch operation. E.g. why an error occurs during creation.

        • status number

          Http status code for item during batch operation.

        • openUrl string
        • createdAt string

          format = "date-time"

        • createdBy string

          format = "uid"

        • resourceId string

          Different formats based on resource type. Could be e.g. OID or UUID.

        • resourceType string

          Can be one of: "app""dataset"

        • subResourceId string

          Different formats based on subresource type. Could be e.g. OID or UUID.

        • resourceSpaceId string

          format = "uid"

        • subResourceName string
        • subResourceType string

          Can be one of: "master_dimension""master_measure""field"

        • subResourceInvalid boolean

          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.
      • revision number
        Required
      • stewards array of strings
        Required

        This list contains the UIDs of the terms data stewards.

      • createdAt string
        Required

        format = "date-time"

      • createdBy string
        Required

        format = "uid"

      • relatesTo array of objects

        Term relations assigned to this term.

        Show relatesTo properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • updatedAt string
        Required

        format = "date-time"

      • updatedBy string
        Required

        The uid of the user who last updated the term

        format = "uid"

      • categories array of strings
      • glossaryId string
        Required

        format = "uuid"

      • description string
        Required
      • abbreviation string
        Required
      • referredRelations array of objects

        Term relations where this term is the target of the relation.

        Show referredRelations properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • relatedInformation string
        Required

        Related information for the term. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.
    • meta object
      Show meta properties
      • countTotal integer
    • links object

      URLs to a resource request

      Show links properties
      • next object
        Show next properties
        • href string
      • prev object
        Show prev properties
        • href string
      • self object
        Show self properties
        • href string

400

The request is in incorrect format

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

The operation failed due to insufficient permissions.

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

The record is not found

  • application/json object
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
GET /api/v1/glossaries/{id}/terms/{termId}/revisions 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.getGlossaryTermRevisions(
  '123e4567-e89b-12d3-a456-426614174000',
  '123e4567-e89b-12d3-a456-426614174000',
  {},
)
qlik glossary term revisions \
  --glossaryId '123e4567-e89b-12d3-a456-426614174000' \
  --termId '123e4567-e89b-12d3-a456-426614174000'
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/revisions" \
-H "Authorization: Bearer <access_token>"

Example 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": [
        "6305e8691a1d504df06e2ab9",
        "63075b341a1d504df06e2abc"
      ],
      "createdAt": "2021-10-02T14:20:50.52Z",
      "createdBy": "507f191e810c19729de860ea",
      "relatesTo": [
        {
          "type": "isA",
          "termId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "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",
      "referredRelations": [
        {
          "type": "isA",
          "termId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "relatedInformation": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"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"
    }
  }
}

Imports a glossary from file.

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

Facts

Rate limit Tier 2 (100 requests per minute)

Query Parameters

  • importerAsFallbackSteward boolean

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

  • lookupUserOnEmail boolean

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

  • spaceId string

    The spaceId (leave blank or omit for personal)

    format = "uid"

Request Body

  • application/json object
    Show application/json properties
    • name string
    • tags array of strings
    • terms array of objects
      Show terms properties
      • id string

        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

      • name string
      • tags array of strings
      • owner array of objects
        Show owner properties
        • name string
        • email string
        • userId string

          format = "uid"

      • linksTo array of objects

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

        Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

        Show linksTo properties
        • type string

          The type of relationship between the term and the linked resource:

          • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
          • related: Use when the term is generally related to the resource but doesn't formally define it

          Can be one of: "definition""related"

        • resourceId string
          Required

          The unique identifier of the resource (app or dataset) to link to the term.

        • resourceType string
          Required

          The type of resource being linked to the term.

          Can be one of: "app""dataset"

        • subResourceId string

          Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

        • subResourceName string

          Required when subResourceType or subResourceId is provided. The display name of the subresource.

        • subResourceType string

          Required when subResourceId or subResourceName is provided. The type of the subresource.

          Can be one of: "master_dimension""master_measure""field"

      • stewards array of objects
        Show stewards properties
        • name string
        • email string
        • userId string

          format = "uid"

      • relatesTo array of objects
        Show relatesTo properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • categories array of strings

        Categories that the term belongs to. Refers to the id property of the category object

      • description string
      • abbreviation string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • spaceId string

      format = "uid"

    • overview string

      Overview of the glossary. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • categories array of objects
      Show categories properties
      • id string

        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.

      • name string

        The name of the category. May not be identical to another category belonging to the same parent.

      • parentId string

        format = "uuid"

      • stewards array of strings
      • description string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • description string
    • termTemplate object
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.
  • application/json+qlik object
    Show application/json+qlik properties
    • name string
    • tags array of strings
    • terms array of objects
      Show terms properties
      • id string

        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

      • name string
      • tags array of strings
      • owner array of objects
        Show owner properties
        • name string
        • email string
        • userId string

          format = "uid"

      • linksTo array of objects

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

        Note: When linking to a subresource (e.g., a master dimension, master measure, or dataset field within an app or dataset), all three subresource fields (subResourceType, subResourceId, and subResourceName) must be provided together. If any one subresource field is specified, all three are required.

        Show linksTo properties
        • type string

          The type of relationship between the term and the linked resource:

          • definition: Use when the term provides the formal definition for the linked resource (e.g., a term defines what a master measure or dimension means)
          • related: Use when the term is generally related to the resource but doesn't formally define it

          Can be one of: "definition""related"

        • resourceId string
          Required

          The unique identifier of the resource (app or dataset) to link to the term.

        • resourceType string
          Required

          The type of resource being linked to the term.

          Can be one of: "app""dataset"

        • subResourceId string

          Required when subResourceType or subResourceName is provided. The unique identifier of the subresource.

        • subResourceName string

          Required when subResourceType or subResourceId is provided. The display name of the subresource.

        • subResourceType string

          Required when subResourceId or subResourceName is provided. The type of the subresource.

          Can be one of: "master_dimension""master_measure""field"

      • stewards array of objects
        Show stewards properties
        • name string
        • email string
        • userId string

          format = "uid"

      • relatesTo array of objects
        Show relatesTo properties
        • type string
          Required

          How the term related to the other object

          Can be one of: "isA""hasA""seeAlso""synonym""antonym""classifies""other""replaces""replacedBy""hasSubtype""preferredTerm""seeInstead""defines""definedBy"

        • termId string
          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"

      • categories array of strings

        Categories that the term belongs to. Refers to the id property of the category object

      • description string
      • abbreviation string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • spaceId string

      format = "uid"

    • overview string

      Overview of the glossary. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • categories array of objects
      Show categories properties
      • id string

        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.

      • name string

        The name of the category. May not be identical to another category belonging to the same parent.

      • parentId string

        format = "uuid"

      • stewards array of strings
      • description string
      • stewardDetails array of objects
        Show stewardDetails properties
        • name string
        • email string
        • userId string

          format = "uid"

    • description string
    • termTemplate object
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.
  • application/json+atlan object

    Atlan glossary format. For more information, see https://docs.atlan.com/

    Show application/json+atlan properties
    • entity object
      Show entity properties
      • guid string
      • labels array of strings
      • status string
      • typeName string
      • attributes object
        Show attributes properties
        • guid string
        • name string
        • usage string
        • examples any
        • relations object
          Show relations properties
          • url string
          • displayName string
        • displayText string
        • abbreviation string
        • relationGuid string
        • parentCategory string
        • userDescription string
      • relationshipAttributes object
        Show relationshipAttributes properties
        • isA object
          Show isA properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • terms object
          Show terms properties
          • guid string
          • typeName string
          • displayText string
          • entityStatus string
        • seeAlso object
          Show seeAlso properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • antonyms object
          Show antonyms properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • synonyms object
          Show synonyms properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • categories object
          Show categories properties
          • guid string
          • typeName string
          • displayText string
          • entityStatus string
        • classifies object
          Show classifies properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • replacedBy object
          Show replacedBy properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
    • referredEntities array of objects
      Show referredEntities properties
      • guid string
      • labels array of strings
      • status string
      • typeName string
      • attributes object
        Show attributes properties
        • guid string
        • name string
        • usage string
        • examples any
        • relations object
          Show relations properties
          • url string
          • displayName string
        • displayText string
        • abbreviation string
        • relationGuid string
        • parentCategory string
        • userDescription string
      • relationshipAttributes object
        Show relationshipAttributes properties
        • isA object
          Show isA properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • terms object
          Show terms properties
          • guid string
          • typeName string
          • displayText string
          • entityStatus string
        • seeAlso object
          Show seeAlso properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • antonyms object
          Show antonyms properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • synonyms object
          Show synonyms properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • categories object
          Show categories properties
          • guid string
          • typeName string
          • displayText string
          • entityStatus string
        • classifies object
          Show classifies properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
        • replacedBy object
          Show replacedBy properties
          • guid string
          • steward string
          • expression string
          • description string
          • displayText string
          • entityStatus string
          • relationGuid string
  • application/json+atlas object
    Show application/json+atlas properties
    • guid string
    • name string
    • terms array of objects
      Show terms properties
      • source string
      • status string
      • steward string
      • termGuid string
      • expression string
      • description string
      • displayText string
      • relationGuid string
    • usage string
    • language string
    • categories array of objects
      Show categories properties
      • description string
      • displayText string
      • categoryGuid string
      • relationGuid string
      • parentCategoryGuid string
    • qualifiedName string
    • longDescription string
    • shortDescription string

Responses

201

Successfully created a new glossary.

  • application/json object
    Show application/json properties
    • id string
      Required

      Unique identifier of the glossary

      format = "uuid"

    • name string
      Required

      Name of the glossary

    • tags array of strings
      Required

      List of tags associated with the glossary.

    • ownerId string
      Required

      The unique identifier of the glossary owner

      format = "uid"

    • spaceId string
      Required

      The unique identifier of the space containing the glossary

      format = "uid"

    • overview string
      Required

      Overview of the glossary contents. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

    • createdAt string
      Required

      Datetime when the glossary was created

      format = "date-time"

    • createdBy string
      Required

      Unique identifier of the user who created the glossary

      format = "uid"

    • updatedAt string
      Required

      Datetime when the glossary was updated

      format = "date-time"

    • updatedBy string
      Required

      The unique identifier of the user who last updated the glossary

      format = "uid"

    • description string
      Required

      Description of the glossary

    • termTemplate object
      Required
      Show termTemplate properties
      • relatedInformation string

        Template text for new terms. This is a rich text field represented as a JSON string. The field is typically generated by the UI but can be set programmatically using the rich text format.

400

See custom codes

  • application/json object

    Custom error codes

    • BG-1 - Context JWT is missing tenantId.
    • BG-2 - Context JWT is missing userId.
    • BG-4 - Invalid or unsupported Content Type. Valid types are: application/json, application/json+qlik, application/json+atlan, application/json+atlas
    • BG-5 - Failed to decode JSON payload.
    • BG-6 - A glossary name is required.
    • BG-7 - Two categories with the same name cannot have the same parent.
    • BG-11 - Glossary validation failed - A value or parameter is invalid or not set
    • BG-12 - Category validation failed - A value or parameter is invalid or not set
    • BG-13 - Term validation failed - A value or parameter is invalid or not set
    • BG-14 - Two or more categories share Id
    • BG-15 - Two or more terms share Id
    • BG-16 - Not detecting proper Atlas format
    • BG-17 - Not detecting proper Atlan format
    • BG-18 - Not detecting proper Qlik format
    • BG-19 - Invalid format in term
    • BG-20 - Duplicate link definition
    • BG-21 - Rich text validation failed. Rich text fields must be valid JSON strings in the format: [{"type":"paragraph","children":[{"text":"your text here"}]}]
    • BG-22 - Import cancelled
    • BG-23 - Duplicate link related
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

403

See custom codes

  • application/json object

    Custom error codes

    • BG-3 - Access denied, no read access
    • BG-30 - Feature not enabled on tenant.
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string

404

See custom codes

  • application/json object

    Custom error codes

    • BG-8 - Glossary not found
    • BG-9 - Category not found
    • BG-10 - Term not found
    Show application/json properties
    • errors array of objects
      Show errors properties
      • code string
      • title string
      • detail string
    • traceId string
POST /api/v1/glossaries/actions/import 
import { createQlikApi } from '@qlik/api'


const qlik = createQlikApi({
  hostConfig: {
    host: 'https://{tenant}.{region}.qlikcloud.com',
    apiKey: '<access-token>',
  },
})


await qlik.glossaries.importGlossary(
  {},
  {
    categories: [
      {
        description: 'string',
        id: '123e4567-e89b-12d3-a456-426614174000',
        name: 'string',
        parentId:
          '123e4567-e89b-12d3-a456-426614174000',
        stewardDetails: [
          {
            email: 'string',
            name: 'string',
            userId:
              'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
          },
        ],
        stewards: ['507f191e810c19729de860ea'],
      },
    ],
    description: 'string',
    name: 'string',
    overview:
      '[{"type":"paragraph","children":[{"text":""}]}]',
    spaceId: '507f191e810c19729de860ea',
    tags: ['tag1', 'tag2'],
    termTemplate: {
      relatedInformation:
        '[{"type":"paragraph","children":[{"text":""}]}]',
    },
    terms: [
      {
        abbreviation: 'abbr',
        categories: [
          '123e4567-e89b-12d3-a456-426614174000',
        ],
        description: 'description',
        id: '123e4567-e89b-12d3-a456-426614174000',
        linksTo: [
          {
            resourceId: 'string',
            resourceType: 'app',
            subResourceId: 'string',
            subResourceName: 'string',
            subResourceType: 'master_dimension',
            type: 'definition',
          },
        ],
        name: 'name',
        owner: [
          {
            email: 'joe.smith@qlik.com',
            name: 'Joe Smith',
            userId: '507f191e810c19729de860ea',
          },
        ],
        relatesTo: [
          {
            termId:
              '123e4567-e89b-12d3-a456-426614174000',
            type: 'isA',
          },
        ],
        stewardDetails: [
          {
            email: 'string',
            name: 'string',
            userId:
              'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
          },
        ],
        stewards: [
          {
            email: 'string',
            name: 'string',
            userId:
              'TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69',
          },
        ],
        tags: ['tag1', 'tag2'],
      },
    ],
  },
)
qlik glossary import-glossary \
  --terms-linksTo-resourceId '' \
  --terms-linksTo-resourceType '' \
  --terms-relatesTo-termId '' \
  --terms-relatesTo-type ''
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/actions/import" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"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":[{"name":"string","email":"string","userId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}]}],"spaceId":"507f191e810c19729de860ea","overview":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]","categories":[{"id":"123e4567-e89b-12d3-a456-426614174000","name":"string","parentId":"123e4567-e89b-12d3-a456-426614174000","stewards":["507f191e810c19729de860ea"],"description":"string","stewardDetails":[{"name":"string","email":"string","userId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}]}],"description":"string","termTemplate":{"relatedInformation":"[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"}}'

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Organization wide glossary",
  "tags": [
    "Red",
    "Sales"
  ],
  "ownerId": "507f191e810c19729de860ea",
  "spaceId": "507f191e810c19729de860ea",
  "overview": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"This glossary contains business terms\"}]}]",
  "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": "[{\"type\":\"paragraph\",\"children\":[{\"text\":\"\"}]}]"
  }
}