Notes

Notes provide a collaborative experience to support analytics consumption in your tenant. This API enables or disables notes.

Download specification

Get the enablement status of the notes feature set for this tenant and user.

Facts

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

Responses

200

Notes enablement status.

  • application/jsonobject
    Show application/json properties
    • reasonstring

      The possible states for the status of notes configuration GET or POST operation

      Can be one of: "deployment""toggle""license"

    • availableboolean
      Required

      'true' if the note feature is enabled for this tenant and user otherwise 'false'.

    • lastFetchstring

      The timestamp for the last time this users notes settings were fetched from downstream services.

500

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId

default

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId
GET /api/v1/notes/settings 
import { createQlikApi } from '@qlik/api'


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


await qlik.notes.getNotesSettings()
qlik note settings ls
curl "https://your-tenant.us.qlikcloud.com/api/v1/notes/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

{
  "reason": "deployment",
  "available": true,
  "lastFetch": "string"
}

update the settings

Facts

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

Request Body

Required

A JSON payload containing note settings to put.

  • application/jsonobject
    Show application/json properties
    • toggledOnboolean

      pass 'true' to enable the note toggle for the tenant, 'false' to disable the toggle (other values are ignore).

Responses

200

The newly applied note settings for the tenant.

  • application/jsonobject
    Show application/json properties
    • toggleOnboolean

      'true' if the note feature is enabled for this tenant and user otherwise 'false'.

400

Request content error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId

403

Unauthorized user.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId

500

Internal server error.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId

default

Error response.

  • application/jsonobject
    Show application/json properties
    • errorsarray of objects
      Show errors properties
      • codestring

        Error code specific to notes broker service.

      • titlestring

        Error title.

      • detailstring

        Error cause.
    • traceIdstring

      An optional traceId
PUT /api/v1/notes/settings 
import { createQlikApi } from '@qlik/api'


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


await qlik.notes.setNotesSettings({
  toggledOn: true,
})
qlik note settings update \
--toggledOn=true
curl "https://your-tenant.us.qlikcloud.com/api/v1/notes/settings" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"toggledOn":true}'

Example Response

{
  "toggleOn": true
}