# Glossaries

**Base URL:** `https://{tenant}.{region}.qlikcloud.com`

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.

## Table of Contents

| Method | Path | Description |
|--------|------|-------------|
| `GET` | [`/api/v1/glossaries`](#get-apiv1glossaries) |  |
| `POST` | [`/api/v1/glossaries`](#post-apiv1glossaries) | Only a steward can create a glossary. |
| `GET` | [`/api/v1/glossaries/{id}`](#get-apiv1glossariesid) |  |
| `PATCH` | [`/api/v1/glossaries/{id}`](#patch-apiv1glossariesid) |  |
| `PUT` | [`/api/v1/glossaries/{id}`](#put-apiv1glossariesid) |  |
| `DELETE` | [`/api/v1/glossaries/{id}`](#delete-apiv1glossariesid) |  |
| `GET` | [`/api/v1/glossaries/{id}/actions/export`](#get-apiv1glossariesidactionsexport) |  |
| `GET` | [`/api/v1/glossaries/{id}/categories`](#get-apiv1glossariesidcategories) |  |
| `POST` | [`/api/v1/glossaries/{id}/categories`](#post-apiv1glossariesidcategories) |  |
| `GET` | [`/api/v1/glossaries/{id}/categories/{categoryId}`](#get-apiv1glossariesidcategoriescategoryid) |  |
| `PATCH` | [`/api/v1/glossaries/{id}/categories/{categoryId}`](#patch-apiv1glossariesidcategoriescategoryid) |  |
| `PUT` | [`/api/v1/glossaries/{id}/categories/{categoryId}`](#put-apiv1glossariesidcategoriescategoryid) |  |
| `DELETE` | [`/api/v1/glossaries/{id}/categories/{categoryId}`](#delete-apiv1glossariesidcategoriescategoryid) |  |
| `GET` | [`/api/v1/glossaries/{id}/terms`](#get-apiv1glossariesidterms) |  |
| `POST` | [`/api/v1/glossaries/{id}/terms`](#post-apiv1glossariesidterms) |  |
| `GET` | [`/api/v1/glossaries/{id}/terms/{termId}`](#get-apiv1glossariesidtermstermid) |  |
| `PATCH` | [`/api/v1/glossaries/{id}/terms/{termId}`](#patch-apiv1glossariesidtermstermid) |  |
| `PUT` | [`/api/v1/glossaries/{id}/terms/{termId}`](#put-apiv1glossariesidtermstermid) |  |
| `DELETE` | [`/api/v1/glossaries/{id}/terms/{termId}`](#delete-apiv1glossariesidtermstermid) |  |
| `POST` | [`/api/v1/glossaries/{id}/terms/{termId}/actions/change-status`](#post-apiv1glossariesidtermstermidactionschange-status) | 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. |
| `GET` | [`/api/v1/glossaries/{id}/terms/{termId}/links`](#get-apiv1glossariesidtermstermidlinks) |  |
| `POST` | [`/api/v1/glossaries/{id}/terms/{termId}/links`](#post-apiv1glossariesidtermstermidlinks) | 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. |
| `GET` | [`/api/v1/glossaries/{id}/terms/{termId}/revisions`](#get-apiv1glossariesidtermstermidrevisions) |  |
| `POST` | [`/api/v1/glossaries/actions/import`](#post-apiv1glossariesactionsimport) | Creates a new or updates an existing glossary, including categories and terms, based on a glossary definition file. |

## API Reference

### GET /api/v1/glossaries

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | boolean | No | Optional parameter to request total count for query |
| `limit` | integer | No | The number of glossaries to get. |
| `next` | string | No | Optional parameter to request the next page. |
| `prev` | string | No | Optional parameter to request the previous page. |
| `sort` | string | No | Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: "name", "+name", "-name", "description", "+description", "-description" |

#### Responses

##### 200

Successful Operation.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No |  |
| `meta` | object | No |  |
| `links` | object | No | URLs to a resource request |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier of the glossary |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | Yes | List of tags associated with the glossary. |
| `ownerId` | string | Yes | The unique identifier of the glossary owner |
| `spaceId` | string | Yes | The unique identifier of the space containing the glossary |
| `overview` | string | Yes | 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 | Yes | Datetime when the glossary was created |
| `createdBy` | string | Yes | Unique identifier of the user who created the glossary |
| `updatedAt` | string | Yes | Datetime when the glossary was updated |
| `updatedBy` | string | Yes | The unique identifier of the user who last updated the glossary |
| `description` | string | Yes | Description of the glossary |
| `termTemplate` | object | Yes |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

</details>

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | integer | No |  |

</details>

<details>
<summary>Properties of `links`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No |  |
| `prev` | object | No |  |
| `self` | object | No |  |

<details>
<summary>Properties of `next`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `prev`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `self`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
    }
  }
}
```

---

### POST /api/v1/glossaries

Only a steward can create a glossary.

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | No | List of tags for glossary |
| `spaceId` | string | No | Unique unique identifier of the space to contain the glossary |
| `overview` | string | No | 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 | No | Description of the glossary |
| `termTemplate` | object | No |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

#### Responses

##### 201

Successfully created a new glossary.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier of the glossary |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | Yes | List of tags associated with the glossary. |
| `ownerId` | string | Yes | The unique identifier of the glossary owner |
| `spaceId` | string | Yes | The unique identifier of the space containing the glossary |
| `overview` | string | Yes | 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 | Yes | Datetime when the glossary was created |
| `createdBy` | string | Yes | Unique identifier of the user who created the glossary |
| `updatedAt` | string | Yes | Datetime when the glossary was updated |
| `updatedBy` | string | Yes | The unique identifier of the user who last updated the glossary |
| `description` | string | Yes | Description of the glossary |
| `termTemplate` | object | Yes |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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":""}]}]',
      },
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries yet.
```

**cURL:**

```bash
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:**

```json
{
  "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\":\"\"}]}]"
  }
}
```

---

### GET /api/v1/glossaries/{id}

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The id of the glossary to retrieve. |

#### Responses

##### 200

Successfully retrieved the glossary.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier of the glossary |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | Yes | List of tags associated with the glossary. |
| `ownerId` | string | Yes | The unique identifier of the glossary owner |
| `spaceId` | string | Yes | The unique identifier of the space containing the glossary |
| `overview` | string | Yes | 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 | Yes | Datetime when the glossary was created |
| `createdBy` | string | Yes | Unique identifier of the user who created the glossary |
| `updatedAt` | string | Yes | Datetime when the glossary was updated |
| `updatedBy` | string | Yes | The unique identifier of the user who last updated the glossary |
| `description` | string | Yes | Description of the glossary |
| `termTemplate` | object | Yes |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The glossary is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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\":\"\"}]}]"
  }
}
```

---

### PATCH /api/v1/glossaries/{id}

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched. |

#### Request Body

**Required**

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `op` | string | Yes | The operation to be performed. Enum: "replace" |
| `path` | string | Yes | A JSON Pointer. |
| `value` | string \| number | Yes | The value to be used for this operation. |

<details>
<summary>Properties of `value`</summary>

**One of:**

**Option 1:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | string | No |  |

**Option 2:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | number | No |  |

</details>

#### Responses

##### 204

Glossary updated successfully.

##### 400

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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 401

Not authorized.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The term to patch was not found.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 429

Request has been rate limited.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PATCH /api/v1/glossaries/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify([
      {
        op: 'replace',
        path: '/name',
        value: 'new name',
      },
      {
        op: 'replace',
        path: '/description',
        value: 'new description',
      },
    ]),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PATCH /api/v1/glossaries/{id} yet.
```

**cURL:**

```bash
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"}]'
```

---

### PUT /api/v1/glossaries/{id}

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The id of the glossary to update. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the glossary was fetched. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | No | List of tags for glossary |
| `spaceId` | string | No | Unique unique identifier of the space to contain the glossary |
| `overview` | string | No | 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 | No | Description of the glossary |
| `termTemplate` | object | No |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

#### Responses

##### 200

Successfully updated the glossary.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier of the glossary |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | Yes | List of tags associated with the glossary. |
| `ownerId` | string | Yes | The unique identifier of the glossary owner |
| `spaceId` | string | Yes | The unique identifier of the space containing the glossary |
| `overview` | string | Yes | 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 | Yes | Datetime when the glossary was created |
| `createdBy` | string | Yes | Unique identifier of the user who created the glossary |
| `updatedAt` | string | Yes | Datetime when the glossary was updated |
| `updatedBy` | string | Yes | The unique identifier of the user who last updated the glossary |
| `description` | string | Yes | Description of the glossary |
| `termTemplate` | object | Yes |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PUT /api/v1/glossaries/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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":""}]}]',
      },
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PUT /api/v1/glossaries/{id} yet.
```

**cURL:**

```bash
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:**

```json
{
  "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\":\"\"}]}]"
  }
}
```

---

### DELETE /api/v1/glossaries/{id}

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The id of the glossary to delete. |

#### Responses

##### 204

Successful Operation.

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The glossary is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `DELETE /api/v1/glossaries/{id}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for DELETE /api/v1/glossaries/{id} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"
```

---

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

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `format` | string | No | The output format Enum: "json", "xlsx" |

#### Responses

##### 200

Successfully exported the glossary.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `tags` | string[] | No |  |
| `terms` | object[] | No |  |
| `ownerId` | string | No |  |
| `spaceId` | string | No |  |
| `overview` | string | No | 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 | No |  |
| `createdBy` | string | No |  |
| `updatedAt` | string | No |  |
| `updatedBy` | string | No | The uid of the user who last updated the glossary |
| `categories` | object[] | No |  |
| `description` | string | No |  |
| `termTemplate` | object | No |  |

<details>
<summary>Properties of `terms`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No |  |
| `tags` | string[] | No |  |
| `owner` | object[] | No |  |
| `linksTo` | object[] | No | 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. |
| `stewards` | object[] | No |  |
| `relatesTo` | object[] | No |  |
| `categories` | string[] | No | Categories that the term belongs to. Refers to the `id` property of the category object |
| `description` | string | No |  |
| `abbreviation` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `owner`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

</details>

<details>
<summary>Properties of `stewards`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `categories`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No | The name of the category. May not be identical to another category belonging to the same parent. |
| `parentId` | string | No |  |
| `description` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

**Content-Type:** `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` | string | No |  |

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The glossary is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/actions/export` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/actions/export',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/actions/export yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/actions/export" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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\":\"\"}]}]"
  }
}
```

---

### GET /api/v1/glossaries/{id}/categories

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | boolean | No | Optional parameter to request total count for query |
| `limit` | integer | No | The number of terms to get. |
| `next` | string | No | Optional parameter to request the next page. |
| `prev` | string | No | Optional parameter to request the previous page. |
| `sort` | string | No | Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: "description", "+description", "-description", "name", "+name", "-name", "update", "+update", "-update" |

#### Responses

##### 200

Successful Operation.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | Yes |  |
| `meta` | object | No |  |
| `links` | object | No | URLs to a resource request |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | 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 | Yes |  |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the category |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |

</details>

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | integer | No |  |

</details>

<details>
<summary>Properties of `links`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No |  |
| `prev` | object | No |  |
| `self` | object | No |  |

<details>
<summary>Properties of `next`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `prev`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `self`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/categories` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/categories yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
    }
  }
}
```

---

### POST /api/v1/glossaries/{id}/categories

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | The name of the category. May not be identical to another category belonging to the same parent. |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `description` | string | No |  |

#### Responses

##### 201

Successfully created a new category.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | 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 | Yes |  |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the category |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries/{id}/categories` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'string',
      parentId:
        '123e4567-e89b-12d3-a456-426614174000',
      stewards: [
        '6305e8691a1d504df06e2ab9',
        '63075b341a1d504df06e2abc',
      ],
      description: 'string',
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries/{id}/categories yet.
```

**cURL:**

```bash
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:**

```json
{
  "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"
}
```

---

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

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `categoryId` | string | Yes | The category id. |
| `id` | string | Yes | The glossary id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched. |

#### Responses

##### 200

Successfully retrieved the category.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | 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 | Yes |  |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the category |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/categories/{categoryId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories/{categoryId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/categories/{categoryId} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
}
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `categoryId` | string | Yes | The category id. |
| `id` | string | Yes | The glossary id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched. |

#### Request Body

**Required**

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `op` | string | Yes | The operation to be performed. Enum: "replace" |
| `path` | string | Yes | A JSON Pointer. |
| `value` | string \| number | Yes | The value to be used for this operation. |

<details>
<summary>Properties of `value`</summary>

**One of:**

**Option 1:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | string | No |  |

**Option 2:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | number | No |  |

</details>

#### Responses

##### 204

Category updated successfully.

##### 400

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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 401

Not authorized.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The term to patch was not found.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 429

Request has been rate limited.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PATCH /api/v1/glossaries/{id}/categories/{categoryId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories/{categoryId}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify([
      {
        op: 'replace',
        path: '/name',
        value: 'new name',
      },
      {
        op: 'replace',
        path: '/description',
        value: 'new description',
      },
    ]),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PATCH /api/v1/glossaries/{id}/categories/{categoryId} yet.
```

**cURL:**

```bash
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"}]'
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `categoryId` | string | Yes | The category id. |
| `id` | string | Yes | The glossary id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the category was fetched. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | The name of the category. May not be identical to another category belonging to the same parent. |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `description` | string | No |  |

#### Responses

##### 200

Successfully updated the category.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | 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 | Yes |  |
| `parentId` | string | No |  |
| `stewards` | string[] | No | This list contains the UIDs of the stewards of the category. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the category |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PUT /api/v1/glossaries/{id}/categories/{categoryId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories/{categoryId}',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'string',
      parentId:
        '123e4567-e89b-12d3-a456-426614174000',
      stewards: [
        '6305e8691a1d504df06e2ab9',
        '63075b341a1d504df06e2abc',
      ],
      description: 'string',
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PUT /api/v1/glossaries/{id}/categories/{categoryId} yet.
```

**cURL:**

```bash
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:**

```json
{
  "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"
}
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `categoryId` | string | Yes | The id for the category to delete. All subcategories are also deleted |
| `id` | string | Yes | The id of the glossary. |

#### Responses

##### 204

Successful Operation.

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `DELETE /api/v1/glossaries/{id}/categories/{categoryId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/categories/{categoryId}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for DELETE /api/v1/glossaries/{id}/categories/{categoryId} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/categories/{categoryId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"
```

---

### GET /api/v1/glossaries/{id}/terms

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Query Parameters

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

#### Responses

##### 200

Successful Operation.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | Yes |  |
| `meta` | object | No |  |
| `links` | object | No | URLs to a resource request |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

</details>

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | integer | No |  |

</details>

<details>
<summary>Properties of `links`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No |  |
| `prev` | object | No |  |
| `self` | object | No |  |

<details>
<summary>Properties of `next`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `prev`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `self`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/terms` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/terms yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
    }
  }
}
```

---

### POST /api/v1/glossaries/{id}/terms

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes |  |
| `tags` | string[] | No |  |
| `linksTo` | object[] | No | 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. |
| `stewards` | string[] | No | This list contain the UIDs for the term's stewards |
| `relatesTo` | object[] | No |  |
| `categories` | string[] | No | Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document. |
| `description` | string | No |  |
| `abbreviation` | string | No |  |
| `relatedInformation` | string | No | 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. |

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

#### Responses

##### 201

Successfully created a new term.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries/{id}/terms` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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."}]}]',
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries/{id}/terms yet.
```

**cURL:**

```bash
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:**

```json
{
  "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.\"}]}]"
}
```

---

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

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Responses

##### 200

Successfully retrieved the term.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/terms/{termId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/terms/{termId} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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.\"}]}]"
}
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched. |

#### Request Body

**Required**

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `op` | string | Yes | The operation to be performed. Enum: "replace" |
| `path` | string | Yes | A JSON Pointer. |
| `value` | string \| number | Yes | The value to be used for this operation. |

<details>
<summary>Properties of `value`</summary>

**One of:**

**Option 1:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | string | No |  |

**Option 2:**

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `` | number | No |  |

</details>

#### Responses

##### 204

Term updated successfully.

##### 400

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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 401

Not authorized.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The term to patch was not found.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 412

Conditional update failed. Trying to modify an old version.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 429

Request has been rate limited.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PATCH /api/v1/glossaries/{id}/terms/{termId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}',
  {
    method: 'PATCH',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify([
      {
        op: 'replace',
        path: '/name',
        value: 'new name',
      },
      {
        op: 'replace',
        path: '/description',
        value: 'new description',
      },
    ]),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PATCH /api/v1/glossaries/{id}/terms/{termId} yet.
```

**cURL:**

```bash
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"}]'
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | Yes |  |
| `tags` | string[] | No |  |
| `linksTo` | object[] | No | 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. |
| `stewards` | string[] | No | This list contain the UIDs for the term's stewards |
| `relatesTo` | object[] | No |  |
| `categories` | string[] | No | Category Ids that the term belongs to. NOTE! In case of import the string refers to the index of the category in the import document. |
| `description` | string | No |  |
| `abbreviation` | string | No |  |
| `relatedInformation` | string | No | 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. |

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

#### Responses

##### 200

Successfully updated the term.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 412

Conditional update failed. Trying to modify an old version.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `PUT /api/v1/glossaries/{id}/terms/{termId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}',
  {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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."}]}]',
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for PUT /api/v1/glossaries/{id}/terms/{termId} yet.
```

**cURL:**

```bash
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:**

```json
{
  "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.\"}]}]"
}
```

---

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

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Responses

##### 204

Successful Operation.

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `DELETE /api/v1/glossaries/{id}/terms/{termId}` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}',
  {
    method: 'DELETE',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for DELETE /api/v1/glossaries/{id}/terms/{termId} yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"
```

---

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

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.

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | string | Yes | The status to update to. Enum: "draft", "verified", "deprecated" |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched. |

#### Responses

##### 200

Successfully updated the term status.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 412

Conditional update failed. Trying to modify an old version.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries/{id}/terms/{termId}/actions/change-status` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}/actions/change-status',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries/{id}/terms/{termId}/actions/change-status yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/actions/change-status" \
-X POST \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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.\"}]}]"
}
```

---

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

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | boolean | No | Optional parameter to request total count for query |
| `filter` | string | No | Optional SCIM filter to be used to filter terms |
| `limit` | integer | No | The number of terms to get. |
| `next` | string | No | Optional parameter to request the next page. |
| `prev` | string | No | Optional parameter to request the previous page. |
| `sort` | string | No | Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: "type", "+type", "-type", "subtype", "+subtype", "-subtype", "created", "+created", "-created" |

#### Responses

##### 200

Successful Operation.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `meta` | object | No |  |
| `links` | object | No | URLs to a resource request |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | integer | No |  |

</details>

<details>
<summary>Properties of `links`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No |  |
| `prev` | object | No |  |
| `self` | object | No |  |

<details>
<summary>Properties of `next`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `prev`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `self`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/terms/{termId}/links` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}/links',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/terms/{termId}/links yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/links" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
    }
  }
}
```

---

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

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.

- **Rate Limit:** Tier 2 (100 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Header Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `if-match` | string | No | Optional header to do conditional updates. Using the Etag value that was returned the last time the term was fetched. |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

#### Responses

##### 201

Successfully created the link.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 412

Conditional update failed. Trying to modify an old version.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries/{id}/terms/{termId}/links` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}/links',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      type: 'definition',
      resourceId: 'string',
      resourceType: 'app',
      subResourceId: 'string',
      subResourceName: 'string',
      subResourceType: 'master_dimension',
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries/{id}/terms/{termId}/links yet.
```

**cURL:**

```bash
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:**

```json
{
  "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
}
```

---

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

- **Rate Limit:** Tier 1 (1000 requests per minute)

#### Path Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The glossary id. |
| `termId` | string | Yes | The term id. |

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | boolean | No | Optional parameter to request total count for query |
| `limit` | integer | No | The number of terms to get. |
| `next` | string | No | Optional parameter to request the next page. |
| `prev` | string | No | Optional parameter to request the previous page. |
| `sort` | string | No | Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending. Enum: "update", "+update", "-update" |

#### Responses

##### 200

Successfully retrieved the revisions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `data` | object[] | Yes |  |
| `meta` | object | No |  |
| `links` | object | No | URLs to a resource request |

<details>
<summary>Properties of `data`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes |  |
| `name` | string | Yes |  |
| `tags` | string[] | Yes |  |
| `status` | object | Yes | Terms status is used determine the status of a term |
| `linksTo` | object[] | No | Describes links to other entities such as qlik charts, dataset columns etc. |
| `revision` | number | Yes |  |
| `stewards` | string[] | Yes | This list contains the UIDs of the terms data stewards. |
| `createdAt` | string | Yes |  |
| `createdBy` | string | Yes |  |
| `relatesTo` | object[] | No | Term relations assigned to this term. |
| `updatedAt` | string | Yes |  |
| `updatedBy` | string | Yes | The uid of the user who last updated the term |
| `categories` | string[] | No |  |
| `glossaryId` | string | Yes |  |
| `description` | string | Yes |  |
| `abbreviation` | string | Yes |  |
| `referredRelations` | object[] | No | Term relations where this term is the target of the relation. |
| `relatedInformation` | string | Yes | 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. |

<details>
<summary>Properties of `status`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | Enum: "draft", "verified", "deprecated" |
| `updatedAt` | string | Yes | Time when the state was changed |
| `updatedBy` | string | Yes | The unique identifier of the user who last changed the status of the term |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No |  |
| `name` | string | No |  |
| `type` | string | No | Enum: "definition", "related" |
| `title` | string | No | Describes reason for item status during batch operation. E.g. why an error occurs during creation. |
| `status` | number | No | Http status code for item during batch operation. |
| `openUrl` | string | No |  |
| `createdAt` | string | No |  |
| `createdBy` | string | No |  |
| `resourceId` | string | No | Different formats based on resource type. Could be e.g. OID or UUID. |
| `resourceType` | string | No | Enum: "app", "dataset" |
| `subResourceId` | string | No | Different formats based on subresource type. Could be e.g. OID or UUID. |
| `resourceSpaceId` | string | No |  |
| `subResourceName` | string | No |  |
| `subResourceType` | string | No | Enum: "master_dimension", "master_measure", "field" |
| `subResourceInvalid` | boolean | No | 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. |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `referredRelations`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

</details>

<details>
<summary>Properties of `meta`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `countTotal` | integer | No |  |

</details>

<details>
<summary>Properties of `links`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `next` | object | No |  |
| `prev` | object | No |  |
| `self` | object | No |  |

<details>
<summary>Properties of `next`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `prev`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

<details>
<summary>Properties of `self`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `href` | string | No |  |

</details>

</details>

##### 400

The request is in incorrect format

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

The operation failed due to insufficient permissions.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

The record is not found

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `GET /api/v1/glossaries/{id}/terms/{termId}/revisions` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/{id}/terms/{termId}/revisions',
  {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json',
    },
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for GET /api/v1/glossaries/{id}/terms/{termId}/revisions yet.
```

**cURL:**

```bash
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/glossaries/{id}/terms/{termId}/revisions" \
-H "Authorization: Bearer <access_token>"
```

**Example Response:**

```json
{
  "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"
    }
  }
}
```

---

### POST /api/v1/glossaries/actions/import

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.


- **Rate Limit:** Tier 2 (100 requests per minute)

#### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `importerAsFallbackSteward` | boolean | No | Appending the current importer user as steward to categories/terms where no steward is defined/not match the identity service. |
| `lookupUserOnEmail` | boolean | No | Using email in the steward fields to lookup userIds in the identity service |
| `spaceId` | string | No | The spaceId (leave blank or omit for personal) |

#### Request Body

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `tags` | string[] | No |  |
| `terms` | object[] | No |  |
| `spaceId` | string | No |  |
| `overview` | string | No | 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` | object[] | No |  |
| `description` | string | No |  |
| `termTemplate` | object | No |  |

<details>
<summary>Properties of `terms`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No |  |
| `tags` | string[] | No |  |
| `owner` | object[] | No |  |
| `linksTo` | object[] | No | 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. |
| `stewards` | object[] | No |  |
| `relatesTo` | object[] | No |  |
| `categories` | string[] | No | Categories that the term belongs to. Refers to the `id` property of the category object |
| `description` | string | No |  |
| `abbreviation` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `owner`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

</details>

<details>
<summary>Properties of `stewards`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `categories`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No | The name of the category. May not be identical to another category belonging to the same parent. |
| `parentId` | string | No |  |
| `stewards` | string[] | No |  |
| `description` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

**Content-Type:** `application/json+qlik`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `tags` | string[] | No |  |
| `terms` | object[] | No |  |
| `spaceId` | string | No |  |
| `overview` | string | No | 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` | object[] | No |  |
| `description` | string | No |  |
| `termTemplate` | object | No |  |

<details>
<summary>Properties of `terms`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No |  |
| `tags` | string[] | No |  |
| `owner` | object[] | No |  |
| `linksTo` | object[] | No | 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. |
| `stewards` | object[] | No |  |
| `relatesTo` | object[] | No |  |
| `categories` | string[] | No | Categories that the term belongs to. Refers to the `id` property of the category object |
| `description` | string | No |  |
| `abbreviation` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `owner`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `linksTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | No | 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  Enum: "definition", "related" |
| `resourceId` | string | Yes | The unique identifier of the resource (app or dataset) to link to the term. |
| `resourceType` | string | Yes | The type of resource being linked to the term. Enum: "app", "dataset" |
| `subResourceId` | string | No | Required when subResourceType or subResourceName is provided. The unique identifier of the subresource. |
| `subResourceName` | string | No | Required when subResourceType or subResourceId is provided. The display name of the subresource. |
| `subResourceType` | string | No | Required when subResourceId or subResourceName is provided. The type of the subresource. Enum: "master_dimension", "master_measure", "field" |

</details>

<details>
<summary>Properties of `stewards`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

<details>
<summary>Properties of `relatesTo`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `type` | string | Yes | How the term related to the other object Enum: "isA", "hasA", "seeAlso", "synonym", "antonym", "classifies", "other", "replaces", "replacedBy", "hasSubtype", "preferredTerm", "seeInstead", "defines", "definedBy" |
| `termId` | string | Yes | 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. |

</details>

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `categories`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | No | 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 | No | The name of the category. May not be identical to another category belonging to the same parent. |
| `parentId` | string | No |  |
| `stewards` | string[] | No |  |
| `description` | string | No |  |
| `stewardDetails` | object[] | No |  |

<details>
<summary>Properties of `stewardDetails`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No |  |
| `email` | string | No |  |
| `userId` | string | No |  |

</details>

</details>

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

**Content-Type:** `application/json+atlan`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `entity` | object | No |  |
| `referredEntities` | object[] | No |  |

<details>
<summary>Properties of `entity`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No |  |
| `labels` | string[] | No |  |
| `status` | string | No |  |
| `typeName` | string | No |  |
| `attributes` | object | No |  |
| `relationshipAttributes` | object | No |  |

<details>
<summary>Properties of `attributes`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No |  |
| `name` | string | No |  |
| `usage` | string | No |  |
| `examples` | any | No |  |
| `relations` | object | No |  |
| `displayText` | string | No |  |
| `abbreviation` | string | No |  |
| `relationGuid` | string | No |  |
| `parentCategory` | string | No |  |
| `userDescription` | string | No |  |

<details>
<summary>Properties of `relations`</summary>

_Properties truncated due to depth limit._

</details>

</details>

<details>
<summary>Properties of `relationshipAttributes`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `isA` | object | No |  |
| `terms` | object | No |  |
| `seeAlso` | object | No |  |
| `antonyms` | object | No |  |
| `synonyms` | object | No |  |
| `categories` | object | No |  |
| `classifies` | object | No |  |
| `replacedBy` | object | No |  |

<details>
<summary>Properties of `isA`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `terms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `seeAlso`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `antonyms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `synonyms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `categories`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `classifies`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `replacedBy`</summary>

_Properties truncated due to depth limit._

</details>

</details>

</details>

<details>
<summary>Properties of `referredEntities`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No |  |
| `labels` | string[] | No |  |
| `status` | string | No |  |
| `typeName` | string | No |  |
| `attributes` | object | No |  |
| `relationshipAttributes` | object | No |  |

<details>
<summary>Properties of `attributes`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No |  |
| `name` | string | No |  |
| `usage` | string | No |  |
| `examples` | any | No |  |
| `relations` | object | No |  |
| `displayText` | string | No |  |
| `abbreviation` | string | No |  |
| `relationGuid` | string | No |  |
| `parentCategory` | string | No |  |
| `userDescription` | string | No |  |

<details>
<summary>Properties of `relations`</summary>

_Properties truncated due to depth limit._

</details>

</details>

<details>
<summary>Properties of `relationshipAttributes`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `isA` | object | No |  |
| `terms` | object | No |  |
| `seeAlso` | object | No |  |
| `antonyms` | object | No |  |
| `synonyms` | object | No |  |
| `categories` | object | No |  |
| `classifies` | object | No |  |
| `replacedBy` | object | No |  |

<details>
<summary>Properties of `isA`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `terms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `seeAlso`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `antonyms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `synonyms`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `categories`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `classifies`</summary>

_Properties truncated due to depth limit._

</details>

<details>
<summary>Properties of `replacedBy`</summary>

_Properties truncated due to depth limit._

</details>

</details>

</details>

**Content-Type:** `application/json+atlas`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `guid` | string | No |  |
| `name` | string | No |  |
| `terms` | object[] | No |  |
| `usage` | string | No |  |
| `language` | string | No |  |
| `categories` | object[] | No |  |
| `qualifiedName` | string | No |  |
| `longDescription` | string | No |  |
| `shortDescription` | string | No |  |

<details>
<summary>Properties of `terms`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `source` | string | No |  |
| `status` | string | No |  |
| `steward` | string | No |  |
| `termGuid` | string | No |  |
| `expression` | string | No |  |
| `description` | string | No |  |
| `displayText` | string | No |  |
| `relationGuid` | string | No |  |

</details>

<details>
<summary>Properties of `categories`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string | No |  |
| `displayText` | string | No |  |
| `categoryGuid` | string | No |  |
| `relationGuid` | string | No |  |
| `parentCategoryGuid` | string | No |  |

</details>

#### Responses

##### 201

Successfully created a new glossary.

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier of the glossary |
| `name` | string | Yes | Name of the glossary |
| `tags` | string[] | Yes | List of tags associated with the glossary. |
| `ownerId` | string | Yes | The unique identifier of the glossary owner |
| `spaceId` | string | Yes | The unique identifier of the space containing the glossary |
| `overview` | string | Yes | 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 | Yes | Datetime when the glossary was created |
| `createdBy` | string | Yes | Unique identifier of the user who created the glossary |
| `updatedAt` | string | Yes | Datetime when the glossary was updated |
| `updatedBy` | string | Yes | The unique identifier of the user who last updated the glossary |
| `description` | string | Yes | Description of the glossary |
| `termTemplate` | object | Yes |  |

<details>
<summary>Properties of `termTemplate`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `relatedInformation` | string | No | 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. |

</details>

##### 400

See custom codes

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 403

See custom codes

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

##### 404

See custom codes

**Content-Type:** `application/json`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `errors` | object[] | No |  |
| `traceId` | string | No |  |

<details>
<summary>Properties of `errors`</summary>

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | No |  |
| `title` | string | No |  |
| `detail` | string | No |  |

</details>

#### Examples

**JavaScript:**

```javascript
// qlik-api has not implemented support for `POST /api/v1/glossaries/actions/import` yet.
// In the meantime, you can use fetch like this:

const response = await fetch(
  '/api/v1/glossaries/actions/import',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      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":""}]}]',
      },
    }),
  },
)

```

**Qlik CLI:**

```bash
# qlik-cli has not implemented support for POST /api/v1/glossaries/actions/import yet.
```

**cURL:**

```bash
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:**

```json
{
  "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\":\"\"}]}]"
  }
}
```

---