Skip to content

Notification digests

Supports chart sharing, chart monitoring and alerting features. The legacy sharing APIs refer to chart sharing and chart monitoring, which is a feature that allows the user to send an e-mail with an embedded chart either manually (chart sharing) or in a recurring manner (chart monitoring). It also stores the history related to these actions. The alerting/ data-alerts APIs support the alerting feature, where a user is able to create alerts that trigger notifications in case a condition in the dataset of an app is fulfilled.

Endpoints

Skip to section
GET/v1/notification-digests
POST/v1/notification-digests
PATCH/v1/notification-digests
DELETE/v1/notification-digests
GET/v1/notification-digests/{digestId}
PATCH/v1/notification-digests/{digestId}
DELETE/v1/notification-digests/{digestId}
GET/v1/notification-digests/{digestId}/executions
GET/v1/notification-digests/{digestId}/executions/{executionId}

gets a single notification digest.

manage

Facts GET /v1/notification-digests

Rate limit
Tier 1 (1000 requests per minute)

Responses GET /v1/notification-digests

200
optional, application/json

Notification digest was successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

digest not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/notification-digests

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

Response GET /v1/notification-digests

{
  "id": "string",
  "enabled": true,
  "ownerId": "string",
  "tenantId": "string",
  "timezone": "string",
  "frequency": "RRULE:FREQ=DAILY",
  "startTime": "string",
  "chronosJobId": "string",
  "currentWorkflowId": "string"
}

Creates a new notification digest.

manage

Facts POST /v1/notification-digests

Rate limit
Tier 2 (100 requests per minute)

Request Body POST /v1/notification-digests

optional, application/json

The notification digest create request definition.

Responses POST /v1/notification-digests

201
optional, application/json

Notification digest was successfully created.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

POST/v1/notification-digests

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"enabled":true,"frequency":"RRULE:FREQ=DAILY"}'

Request POST /v1/notification-digests

{
  "enabled": true,
  "frequency": "RRULE:FREQ=DAILY"
}

Response POST /v1/notification-digests

{
  "id": "string",
  "enabled": true,
  "ownerId": "string",
  "tenantId": "string",
  "timezone": "string",
  "frequency": "RRULE:FREQ=DAILY",
  "startTime": "string",
  "chronosJobId": "string",
  "currentWorkflowId": "string"
}

Update a notification digest.

manage

Facts PATCH /v1/notification-digests

Rate limit
Tier 2 (100 requests per minute)

Request Body PATCH /v1/notification-digests

optional, application/json

The notification digest patch operations.

Responses PATCH /v1/notification-digests

204
optional
object

Notification digest was successfully updated.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

A notification digest with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

PATCH/v1/notification-digests

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"/enabled","value":false},{"op":"add","path":"/frequency","value":"RRULE:FREQ=WEEKLY"}]'

Request PATCH /v1/notification-digests

[
  {
    "op": "replace",
    "path": "/enabled",
    "value": false
  },
  {
    "op": "add",
    "path": "/frequency",
    "value": "RRULE:FREQ=WEEKLY"
  }
]

deletes a notification digest.

manage

Facts DELETE /v1/notification-digests

Rate limit
Tier 2 (100 requests per minute)

Responses DELETE /v1/notification-digests

204
optional
object

The notification digest has been successfully deleted.

400
optional, application/json

The specified digest ID is invalid (e.g. not a number).

404
optional, application/json

A notification digest with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

DELETE/v1/notification-digests

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

gets a single notification digest.

manage

Facts GET /v1/notification-digests/{digestId}

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/notification-digests/{digestId}

digestId
string

The notification digest task identifier.

Responses GET /v1/notification-digests/{digestId}

200
optional, application/json

Notification digest was successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

digest not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/notification-digests/{digestId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests/{digestId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/notification-digests/{digestId}

{
  "id": "string",
  "enabled": true,
  "ownerId": "string",
  "tenantId": "string",
  "timezone": "string",
  "frequency": "RRULE:FREQ=DAILY",
  "startTime": "string",
  "chronosJobId": "string",
  "currentWorkflowId": "string"
}

Update a notification digest.

manage

Facts PATCH /v1/notification-digests/{digestId}

Rate limit
Tier 2 (100 requests per minute)

Path Parameters PATCH /v1/notification-digests/{digestId}

digestId
string

The notification digest task identifier.

Request Body PATCH /v1/notification-digests/{digestId}

optional, application/json

The notification digest patch operations.

Responses PATCH /v1/notification-digests/{digestId}

204
optional
object

Notification digest was successfully updated.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

A notification digest with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

PATCH/v1/notification-digests/{digestId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests/{digestId}" \
 -X PATCH \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '[{"op":"replace","path":"/enabled","value":false},{"op":"add","path":"/frequency","value":"RRULE:FREQ=WEEKLY"}]'

Request PATCH /v1/notification-digests/{digestId}

[
  {
    "op": "replace",
    "path": "/enabled",
    "value": false
  },
  {
    "op": "add",
    "path": "/frequency",
    "value": "RRULE:FREQ=WEEKLY"
  }
]

deletes a notification digest.

manage

Facts DELETE /v1/notification-digests/{digestId}

Rate limit
Tier 2 (100 requests per minute)

Path Parameters DELETE /v1/notification-digests/{digestId}

digestId
string

The notification digest task identifier.

Responses DELETE /v1/notification-digests/{digestId}

204
optional
object

The notification digest has been successfully deleted.

400
optional, application/json

The specified digest ID is invalid (e.g. not a number).

404
optional, application/json

A notification digest with the specified ID was not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

DELETE/v1/notification-digests/{digestId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests/{digestId}" \
 -X DELETE \
 -H "Authorization: Bearer <API-key>"

List all notification digest executions based on filters.

manage

Facts GET /v1/notification-digests/{digestId}/executions

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/notification-digests/{digestId}/executions

digestId
string

The notification digest task identifier.

Query Parameters GET /v1/notification-digests/{digestId}/executions

limit
optional, default=100, minimum=1, maximum=100
integer

Limit the returned result set

offset
optional
integer

Offset for finding a list of entities - used for pagination

page
optional
string

The cursor to the page of data.

workflowId
optional
string

The workflow Id for a specific digest

next
deprecated
optional
string

The cursor to the next page of data. Only one of next or previous may be specified.

prev
deprecated
optional
string

No description

Responses GET /v1/notification-digests/{digestId}/executions

200
optional, application/json
NotificationDigestExecutions

Notification digest executions were successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/notification-digests/{digestId}/executions

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests/{digestId}/executions" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/notification-digests/{digestId}/executions

{
  "undefined": {
    "totalCount": 0,
    "currentPageCount": 0,
    "links": {
      "next": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "prev": {
        "href": "http://localhost:8787/v1/items?limit=12",
        "type": "next",
        "token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
      },
      "self": {
        "href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
      }
    },
    "executions": [
      {
        "id": "string",
        "content": {},
        "ownerId": "string",
        "expireAt": "2019-10-15T16:07:01.492Z",
        "tenantId": "string",
        "resourceId": "string",
        "workflowId": "string",
        "dateCreated": "2019-10-15T16:07:01.492Z",
        "resourceType": "string",
        "secureContent": {},
        "executionFlowStartTime": "2019-10-15T16:07:01.492Z"
      }
    ]
  }
}

gets a single notification digest execution.

manage

Facts GET /v1/notification-digests/{digestId}/executions/{executionId}

Rate limit
Tier 1 (1000 requests per minute)

Path Parameters GET /v1/notification-digests/{digestId}/executions/{executionId}

digestId
string

The notification digest task identifier.

executionId
string

The notification digest task identifier.

Responses GET /v1/notification-digests/{digestId}/executions/{executionId}

200
optional, application/json

Notification digest executions were successfully returned.

400
optional, application/json

Bad request, malformed syntax or errors in parameters.

404
optional, application/json

execution not found.

500
optional, application/json

Internal server error.

default
optional, application/json

Error response.

GET/v1/notification-digests/{digestId}/executions/{executionId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/notification-digests/{digestId}/executions/{executionId}" \
 -H "Authorization: Bearer <API-key>"

Response GET /v1/notification-digests/{digestId}/executions/{executionId}

{
  "id": "string",
  "content": {},
  "ownerId": "string",
  "expireAt": "2019-10-15T16:07:01.492Z",
  "tenantId": "string",
  "resourceId": "string",
  "workflowId": "string",
  "dateCreated": "2019-10-15T16:07:01.492Z",
  "resourceType": "string",
  "secureContent": {},
  "executionFlowStartTime": "2019-10-15T16:07:01.492Z"
}

JsonPatches

Array<JsonPatch>

A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.

Properties

op
string

The operation to be performed.

Enum:

replace

remove

add

path
string

The path for the given resource field to patch.

value
optional
object

The value to be used for this operation.

Error

object

Properties

code
optional
string

Error code specific to sharing service.

meta
optional

No description

title
optional
string

Error title.

detail
optional
string

Error cause.

Error_meta

object

Properties

httpCode
optional
integer

HTTP error code.

Errors

object

Properties

errors
optional

No description

traceId
optional
string

No description

JsonPatch

object

Properties

op
string

The operation to be performed.

Enum:

replace

remove

add

path
string

The path for the given resource field to patch.

value
optional
object

The value to be used for this operation.

object

Properties

next
optional

No description

prev
optional

No description

self
optional

Object with Href to a particular element or set of elements

NotificationDigest

object

Properties

id
optional
string

id of digest

enabled
optional
boolean

Whether the digest is enabled or not

ownerId
optional
string

Owner of the execution

tenantId
optional
string

The tenant that this execution belongs to

timezone
optional
string

the timezone for the chronos job

frequency
optional
string

RRULE for SCHEDULED digest, as specified in RFC5545.

startTime
optional
string

start time of the notification request

chronosJobId
optional
string

The chronos job identifier. It is set once the related chronos job is created.

currentWorkflowId
optional
string

current workflowID to be written in the executions

NotificationDigestCreateRequest

object

Properties

enabled
optional
boolean

Whether the digest is enabled or not

frequency
optional
string

RRULE for SCHEDULED digest, as specified in RFC5545.

NotificationDigestExecution

object

Notification Digest Execution.

Properties

id
optional
string

id of execution

content
optional
object

digest buffer content received from notification-prep

ownerId
optional
string

Owner of the execution

expireAt
optional
string

Timestamp for TTL document deleted after time stamp is reached

tenantId
optional
string

The tenant that this execution belongs to

resourceId
optional
string

resourceId for the digest execution

workflowId
optional
string

workflow Id of related digest

dateCreated
optional
string

Timestamp for the creation of the task execution

resourceType
optional
string

resourceId for the digest execution

secureContent
optional
object

digest buffer secure content received from notification-prep

executionFlowStartTime
optional
string

Timestamp of execution start

NotificationDigestExecutions

list of Notification Digest Executions.

Properties

totalCount
optional
integer

total count of entries in the collection as a whole

currentPageCount
optional
integer

count of entries on the currently shown page

links
optional

No description

executions

No description

Page

object

Properties

href
optional
string

URL to particular set of elements

type
optional
string

Page type, can be next or prev

Enum:

prev

next

token
optional
string

Page unique token

Self

object

Object with Href to a particular element or set of elements

Properties

href
optional
string

No description

StandardListResponseProps

object

properties that should be added to every list response

Properties

totalCount
integer

total count of entries in the collection as a whole

currentPageCount
integer

count of entries on the currently shown page

v0.635.2
Was this page helpful?