Web notifications
Web notifications is the resource representing a user's notification
Endpoints
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Query Parameters
- limitnumber
The number of notification entries to retrieved.
- pagenumber
Page number
- readboolean
Read status of the notification
- resourceTypestring
Filter by resource types. If passing more than 1 resource type, use comma seperated string.
- sortstring
The field to sort by, with +/- prefix indicating sort order
Can be one of: "+createdAt""-createdAt""+updatedAt""-updatedAt"
Responses
200
application/json
An array of notification objects
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- idstringRequired
- bodystringRequired
- metaobjectRequired
- readbooleanRequired
- actionstring
- userIdstringRequired
- spaceIdstring
- tenantIdstring
- createdAtstringRequired
- spaceTypestring
- updatedAtstringRequired
- resourceIdstring
- resourceTypestring
- subResourceTypestring
-
- metaobject
Notifications meta data
meta properties
- unreadCountnumber
The total number of unread notification.
-
- linksobject
Notifications links
links properties
- nextobject
next properties
- hrefstring
-
- prevobject
prev properties
- hrefstring
-
- selfobject
self properties
- hrefstring
-
-
-
400
application/json
Invalid request parameters for querying users.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications" \-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/web-notifications', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "data": [ { "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "body": "string", "meta": {}, "read": true, "action": "string", "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "string", "spaceType": "string", "updatedAt": "string", "resourceId": "string", "resourceType": "string", "subResourceType": "string" } ], "meta": { "unreadCount": 42 }, "links": { "next": { "href": "string" }, "prev": { "href": "string" }, "self": { "href": "string" } }}
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Path Parameters
- notificationIdstringRequired
The id of the notification to retrieve.
Responses
200
application/json
Successfully got notification.
- application/jsonobject
application/json properties
- idstringRequired
- bodystringRequired
- metaobjectRequired
- readbooleanRequired
- actionstring
- userIdstringRequired
- spaceIdstring
- tenantIdstring
- createdAtstringRequired
- spaceTypestring
- updatedAtstringRequired
- resourceIdstring
- resourceTypestring
- subResourceTypestring
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
404
application/json
Not found when user tries to get notification they do not own.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications/{notificationId}" \-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/web-notifications/{notificationId}', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "body": "string", "meta": {}, "read": true, "action": "string", "userId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69", "createdAt": "string", "spaceType": "string", "updatedAt": "string", "resourceId": "string", "resourceType": "string", "subResourceType": "string"}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- notificationIdstringRequired
The id of the notification to update.
Request Body
Requiredapplication/json
An array of JSON Patch documents
- application/jsonarray of objects
An array of JSON Patch documents
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
The path for the given resource field to patch.
Can be one of: "/read"
- valuestringRequired
The value to be used for this operation.
-
Responses
204
application/json
Successfully patched marked notification.
Notifications meta data
- application/jsonobject
Notifications meta data
application/json properties
- unreadCountnumber
The total number of unread notification.
-
400
application/json
Unsupported patch request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
404
application/json
Notification not found.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications/{notificationId}" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/read","value":true}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/read","value":true}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/web-notifications/{notificationId}', 'method': 'PATCH', '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
[ { "op": "replace", "path": "/read", "value": true }]
Response
{ "unreadCount": 42}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- notificationIdstringRequired
The id of the notification to delete.
Responses
204
application/json
Successfully deleted notification.
Notifications meta data
- application/jsonobject
Notifications meta data
application/json properties
- unreadCountnumber
The total number of unread notification.
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
404
application/json
Notification not found.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications/{notificationId}" \-X DELETE \-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/web-notifications/{notificationId}', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "unreadCount": 42}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Request Body
Requiredapplication/json
An array of JSON Patch documents
- application/jsonarray of objects
An array of JSON Patch documents
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
The path for the given resource field to patch.
Can be one of: "/read"
- valuestringRequired
The value to be used for this operation.
-
Responses
204
application/json
Successfully marked all notification.
Notifications meta data
- application/jsonobject
Notifications meta data
application/json properties
- unreadCountnumber
The total number of unread notification.
-
400
application/json
Unsupported patch request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications/all" \-X PATCH \-H "Content-type: application/json" \-H "Authorization: Bearer <access_token>" \-d '[{"op":"replace","path":"/read","value":true}]'
const https = require('https') const data = JSON.stringify([{"op":"replace","path":"/read","value":true}]) const options = { 'hostname': 'https://your-tenant.us.qlikcloud.com', 'port': 443, 'path': '/api/v1/web-notifications/all', 'method': 'PATCH', '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
[ { "op": "replace", "path": "/read", "value": true }]
Response
{ "unreadCount": 42}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Responses
204
application/json
Successfully deleted notification.
Notifications meta data
- application/jsonobject
Notifications meta data
application/json properties
- unreadCountnumber
The total number of unread notification.
-
401
application/json
Unauthorized request.
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
500
application/json
Internal server error
A representation of the errors encountered from the HTTP request.
- application/jsonobject
A representation of the errors encountered from the HTTP request.
application/json properties
- errorsarray of objects
An error object.
errors properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- statusinteger
The HTTP status code.
- messagestring
A human-readable explanation specific to this occurrence of the problem.
-
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/web-notifications/all" \-X DELETE \-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/web-notifications/all', 'method': 'DELETE', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "unreadCount": 42}