Skip to content

Notes

CRUD for notes and note syncing APIs for real time collaborative editing

Endpoints

Skip to section
GET/v1/notes/settings
PUT/v1/notes/settings

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

manage

Facts GET /v1/notes/settings

Rate limit
required
Tier 1 (1000 requests per minute)

Responses GET /v1/notes/settings

200
application/json

Notes enablement status.

500
application/json

Internal server error.

default
application/json

Error response.

GET/v1/notes/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/notes/settings" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/notes/settings

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

update the settings

manage

Facts PUT /v1/notes/settings

Rate limit
required
Tier 2 (100 requests per minute)

Request Body PUT /v1/notes/settings

application/json

A JSON payload containing note settings to put.

Responses PUT /v1/notes/settings

200
application/json

The newly applied note settings for the tenant.

400
application/json

Request content error.

403
application/json

Unauthorized user.

500
application/json

Internal server error.

default
application/json

Error response.

PUT/v1/notes/settings

curl "https://your-tenant.us.qlikcloud.com/api/v1/notes/settings" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"toggledOn":true,"snapshotRelations":true}'

Request PUT /v1/notes/settings

{
  "toggledOn": true,
  "snapshotRelations": true
}

Response PUT /v1/notes/settings

{
  "toggleOn": true,
  "snapshotRelations": true
}

ConfigReasonCode

string

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

Enum:

deployment

toggle

license

Error

object

Properties

code
string

Error code specific to notes broker service.

title
string

Error title.

detail
string

Error cause.

Errors

object

Properties

errors

No description

traceId
string

An optional traceId

NoteSettingsPutPayload

object

Properties

toggledOn
boolean

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

snapshotRelations
boolean

pass 'true' to enable the relations api to search notes for the tenant.

NoteSettingsPutResponse

object

Properties

toggleOn
boolean

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

snapshotRelations
boolean

'true' if relations api to search notes for the tenant are enabled else false.

NotesUserSettings

object

Properties

reason

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

Enum:

deployment

toggle

license

available
required
boolean

'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.

v0.690.0
Was this page helpful?