Notifications
Notifications is the resource representing the various notifications that notification-prep can render
Endpoints
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Query Parameters
- localestring
If present, idenfies the language of the returned 'friendlyName' property.
- manageableInHubstring
If present, represents the 'manageableInHub' value to filter by.
Can be one of: true
- subscribablestring
If present, represents the 'subscribable' value to filter by.
Can be one of: true
Responses
200
application/json
Request completed successfully. See Results for ResultDetail on each notification.
Object containing array representing list of supported notifications
- application/jsonobject
Object containing array representing list of supported notifications
application/json properties
- notificationsarray of objectsRequired
list of notifications
notifications properties
- transportsarray of stringsRequired
Type of Transport e.g. Email, Notification, Slack message etc...
- isSubscribablebooleanRequired
Indicates if the notification can be subscribed to by users. If true, the object will also contain 'subscriptionInfo' object
- presentationInfoobject
Object containing information pertaining to the presentaion of a notification in the UI
presentationInfo properties
- scopesarray of strings
Information about the scopes to which this notification applies. Helps determine the placement of the notification in the UI
- friendlyNamestring
Localized, human-readable string representing the name of the notification suitable to use in a UI
- scopeFriendlyNamesobject
Friendly name to be displayed for each scope.
-
- subscriptionInfoobject
Object indicating what properties to use to subscribe to this notification via the 'Subscriptions' service. For info about its properties, refer to the Subscription sevice's API doc.
subscriptionInfo properties
- actionstringRequired
- targetstring
- resourceIdstring
- resourceTypestringRequired
- resourceSubTypestring
-
- isManageableInHubboolean
Indicates if the notification can be managed in the hub. If true, the object will also contain 'subscriptionInfo' object and a 'presentationInfo' object with a non-empty scopes array.
- notificationNamePatternstringRequired
Notification name pattern that will trigger this notification e.g resource.action
-
-
default
application/json
Request error. See Errors.
An error object.
- application/jsonobject
An error object.
application/json properties
- codestringRequired
The error code.
- titlestringRequired
Summary of the problem.
- detailstring
A human-readable explanation specific to this occurrence of the problem.
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/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/notifications', 'method': 'GET', 'headers': { 'Authorization': 'Bearer <access_token>' } } const req = https.request(options)
This API is not included yet in qlik-cli
Response
{ "notifications": [ { "transports": [ "string" ], "isSubscribable": true, "presentationInfo": { "scopes": [ "string" ], "friendlyName": "string", "scopeFriendlyNames": {} }, "subscriptionInfo": { "action": "string", "target": "string", "resourceId": "string", "resourceType": "string", "resourceSubType": "string" }, "isManageableInHub": true, "notificationNamePattern": "string" } ]}