Web notifications

Web notifications is the resource representing a user's notification

Endpoints

GET

/v1/web-notifications
GET

/v1/web-notifications/{notificationId}
PATCH

/v1/web-notifications/{notificationId}
DELETE

/v1/web-notifications/{notificationId}
PATCH

/v1/web-notifications/all
DELETE

/v1/web-notifications/all

Facts

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

Query Parameters

limitnumber

The number of notification entries to retrieved.

minimum = 0, maximum = 100, default = 10, default = 10
pagenumber

Page number

default = 1, default = 1
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"

default = "-createdAt"

Responses

200

application/json

An array of notification objects

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  format = "uid"
  
  bodystring
  Required
  
  metaobject
  Required
  
  readboolean
  Required
  
  actionstring
  
  format = "string"
  
  userIdstring
  Required
  
  format = "uid"
  
  spaceIdstring
  
  format = "uid"
  
  tenantIdstring
  
  format = "uid"
  
  createdAtstring
  Required
  
  format = "date"
  
  spaceTypestring
  
  updatedAtstring
  Required
  
  format = "date"
  
  resourceIdstring
  
  format = "string"
  
  resourceTypestring
  
  format = "string"
  
  subResourceTypestring
  
  format = "string"
- metaobject
  
  Notifications meta data
  
  Show meta properties
  
  unreadCountnumber
  
  The total number of unread notification.
  
  minimum = 0, maximum = 500
- linksobject
  
  Notifications links
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  
  prevobject
  
  Show prev properties
  
  hrefstring
  
  selfobject
  
  Show 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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

GET /v1/web-notifications

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

notificationIdstring
Required

The id of the notification to retrieve.

format = "uid"

Responses

200

application/json

Successfully got notification.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- bodystring
  Required
- metaobject
  Required
- readboolean
  Required
- actionstring
  
  format = "string"
- userIdstring
  Required
  
  format = "uid"
- spaceIdstring
  
  format = "uid"
- tenantIdstring
  
  format = "uid"
- createdAtstring
  Required
  
  format = "date"
- spaceTypestring
- updatedAtstring
  Required
  
  format = "date"
- resourceIdstring
  
  format = "string"
- resourceTypestring
  
  format = "string"
- subResourceTypestring
  
  format = "string"

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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

GET /v1/web-notifications/{notificationId}

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

notificationIdstring
Required

The id of the notification to update.

format = "uid"

Request Body

Required

application/json

An array of JSON Patch documents

application/jsonarray of objects

An array of JSON Patch documents
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  The path for the given resource field to patch.
  
  Can be one of: "/read"
- valuestring
  Required
  
  The value to be used for this operation.

Responses

204

application/json

Successfully patched marked notification.

Notifications meta data

application/jsonobject

Notifications meta data
Show application/json properties
- unreadCountnumber
  
  The total number of unread notification.
  
  minimum = 0, maximum = 500

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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

PATCH /v1/web-notifications/{notificationId}

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

notificationIdstring
Required

The id of the notification to delete.

format = "uid"

Responses

204

application/json

Successfully deleted notification.

Notifications meta data

application/jsonobject

Notifications meta data
Show application/json properties
- unreadCountnumber
  
  The total number of unread notification.
  
  minimum = 0, maximum = 500

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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

DELETE /v1/web-notifications/{notificationId}

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

Required

application/json

An array of JSON Patch documents

application/jsonarray of objects

An array of JSON Patch documents
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  The path for the given resource field to patch.
  
  Can be one of: "/read"
- valuestring
  Required
  
  The value to be used for this operation.

Responses

204

application/json

Successfully marked all notification.

Notifications meta data

application/jsonobject

Notifications meta data
Show application/json properties
- unreadCountnumber
  
  The total number of unread notification.
  
  minimum = 0, maximum = 500

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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

PATCH /v1/web-notifications/all

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
Show application/json properties
- unreadCountnumber
  
  The total number of unread notification.
  
  minimum = 0, maximum = 500

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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  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.
Show application/json properties
- errorsarray of objects
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  titlestring
  Required
  
  Summary of the problem.
  
  statusinteger
  
  The HTTP status code.
  
  messagestring
  
  A human-readable explanation specific to this occurrence of the problem.

DELETE /v1/web-notifications/all

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
}

Web notifications

Endpoints

Retrieve notifications matching the query.

Facts

Query Parameters

Responses

200

400

401

500

Response

Retrieve a single notification by Id.

Facts

Path Parameters

Responses

200

401

404

500

Response

Patch a notification.

Facts

Path Parameters

Request Body

Responses

204

400

401

404

500

Request

Response

Delete a notification.

Facts

Path Parameters

Responses

204

401

404

500

Response

Patch all notifications.

Facts

Request Body

Responses

204

400

401

500

Request

Response

Delete all notifications.

Facts

Responses

204

401

500

Response