Notes
Notes provide a collaborative experience to support analytics consumption in your tenant. This API enables or disables notes.
Endpoints
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Responses
200
application/json
Notes enablement status.
- application/jsonobject
application/json properties
- reasonstring
The possible states for the status of notes configuration GET or POST operation
Can be one of: "deployment""toggle""license"
- availablebooleanRequired
'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
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/notes/settings" \-H "Authorization: Bearer <access_token>"
const https = require('https') const data = JSON.stringify("") const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/notes/settings', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "reason": "deployment", "available": true, "lastFetch": "string"}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Request Body
Requiredapplication/json
A JSON payload containing note settings to put.
- application/jsonobject
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
application/json
The newly applied note settings for the tenant.
- application/jsonobject
application/json properties
- toggleOnboolean
'true' if the note feature is enabled for this tenant and user otherwise 'false'.
-
400
application/json
Request content error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
403
application/json
Unauthorized user.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
default
application/json
Error response.
- application/jsonobject
application/json properties
- errorsarray of objects
errors properties
- codestring
Error code specific to notes broker service.
- titlestring
Error title.
- detailstring
Error cause.
-
- traceIdstring
An optional traceId
-
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}'
const https = require('https') const data = JSON.stringify({"toggledOn":true}) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/notes/settings', 'method': 'PUT', 'headers': { 'Content-type': 'application/json', 'Authorization': 'Bearer <access_token>' } } const req = https.request(options) req.write(data)
This API is not included yet in qlik-cli
Request
{ "toggledOn": true}
Response
{ "toggleOn": true}