Notes

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

Download OpenAPI spec

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

Deprecated

Facts

Rate limit Tier 1 (1000 requests per minute)
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Responses

200

Notes enablement status.

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

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

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

    • available boolean
      Required

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

    • lastFetch string

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

500

Internal server error.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

      An optional traceId

default

Error response.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

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


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


await qlik.notes.getNotesSettings()
# qlik-cli has not implemented support for GET /api/v1/notes/settings yet.
curl "https://{tenant}.{region}.qlikcloud.com/api/v1/notes/settings" \
-H "Authorization: Bearer <access_token>"

Example Response

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

update the settings

Deprecated

Facts

Rate limit Tier 2 (100 requests per minute)
Deprecated This endpoint is deprecated and will eventually be removed. Read our API policy here.

Request Body

Required

A JSON payload containing note settings to put.

  • application/json object
    Show application/json properties
    • toggledOn boolean

      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/json object
    Show application/json properties
    • toggleOn boolean

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

400

Request content error.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

      An optional traceId

403

Unauthorized user.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

      An optional traceId

500

Internal server error.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

      An optional traceId

default

Error response.

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

        Error code specific to notes broker service.

      • title string

        Error title.

      • detail string

        Error cause.
    • traceId string

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


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


await qlik.notes.setNotesSettings({
  toggledOn: true,
})
# qlik-cli has not implemented support for PUT /api/v1/notes/settings yet.
curl "https://{tenant}.{region}.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
}