notifications

notifications is the resource representing the various notifications that notification-prep can render

Endpoints

Skip to section
GET/notifications

List all supported notifications

Query Parameters GET /notifications

subscribable
optional, default='if missing, all notifications are returned'
string

If present, represents the 'subscribable' value to filter by.

Enum:

true

false

locale
optional, default='en'
string

If present, idenfies the language of the returned 'friendlyName' property.

Responses GET /notifications

200
application/json

Request completed successfully. See Results for ResultDetail on each notification.

default
application/json

Request error. See Errors.

GET/notifications

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

Response GET /notifications

{
  "notifications": [
    {
      "notificationNamePattern": "string",
      "transports": [],
      "isSubscribable": true,
      "subscriptionInfo": {
        "resourceType": "string",
        "resourceSubType": "string",
        "action": "string",
        "resourceId": "string",
        "target": "string"
      },
      "presentationInfo": {
        "friendlyName": "string",
        "scopes": [],
        "scopeFriendlyNames": {}
      }
    }
  ]
}

NotificationsObject

object

Object containing array representing list of supported notifications

Properties

notifications

list of notifications

NotificationItem

object

Notification result item

Properties

notificationNamePattern
string

Notification name pattern that will trigger this notification e.g resource.action

transports
Array<string>

Type of Transport e.g. Email, Notification, Slack message etc...

isSubscribable
boolean

Indicates if the notifcation can be subscribed to by users. If true, the object will also contain s 'subscriptionInfo' object

subscriptionInfo
optional

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.

presentationInfo
optional

Object containing information pertaining to the presentaion of a notification in the UI

RenderAllPostSchema

object

Properties

locale
string

No description

condition
object

List of parameters specific to data condition taken from the Data Condition Evaluator service. See condition object definition in https://github.com/qlik-trial/data-condition-evaluator/blob/master/api-docs.yml where qHyperCubeDef can be ommitted.

evaluationResult
object

List of parameters specific to condition evaluation taken from the Data Condition Evaluator service with the 'negative' property omitted. See DataResult object definition in https://github.com/qlik-trial/data-condition-evaluator/blob/master/api-docs.yml

RenderConditionsPostSchema

object

Properties

locale
string

No description

condition
object

List of parameters specific to data condition taken from the Data Condition Evaluator service. See condition object definition in https://github.com/qlik-trial/data-condition-evaluator/blob/master/api-docs.yml where qHyperCubeDef can be ommitted.

dimensions
Array<string>

array of string representing name of dimensions used in condiitons

measures
Array<string>

array of string representing name of measures used in condiitons

TokenizedLogicalExpressionItem

object

object describing one logical group.

Properties

conditionIds
Array<string>

array containing indices of the conditions that make up a logic group

logicOperators
Array<string>

localized strings that represent the logic operators between the conditions of the group. If a group only has one condition, this array is empty.

nextGroupOperator
string

localized string that represents the logic operator that links this logic group to the next in the array. This property is missing if this is the last logic group in the array.

TokenizedLogicalExpressionSchema

Array<TokenizedLogicalExpressionItem>

array containing logical expression broken down into tokens. Each element in the array represents a logic group as defined in the data alert condition creation UI.

Properties

conditionIds
Array<string>

array containing indices of the conditions that make up a logic group

logicOperators
Array<string>

localized strings that represent the logic operators between the conditions of the group. If a group only has one condition, this array is empty.

nextGroupOperator
string

localized string that represents the logic operator that links this logic group to the next in the array. This property is missing if this is the last logic group in the array.

RenderedConditionsSchema

object

Properties

logicalExpression
string

the numbers represent the condition index in the conditions array

tokenizedLogicalExpression

array containing logical expression broken down into tokens. Each element in the array represents a logic group as defined in the data alert condition creation UI.

conditions

No description

RenderedAllSchema

object

Properties

conditionHeader
string

No description

conditionSubHeader
string

No description

conditionDetails

No description

SecureRenderSchema

object

Object meant to replace the secureRenderId property in the 'transport-request' NATS event data playload

Errors

object

A representation of the errors encountered while processing an HTTP request.

Properties

errors

No description

Error

object

An error object.

Properties

code
string

The error code.

title
string

Summary of the problem.

detail
optional
string

A human-readable explanation specific to this occurrence of the problem.

v1.7.0
Was this page helpful?