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 sectionGET | /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.
Facts GET /v1/notification-digests
Rate limit required | Tier 1 (1000 requests per minute) |
Responses GET /v1/notification-digests
200 application/json | Notification digest was successfully returned. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
404 application/json | digest not found. |
500 application/json | Internal server error. |
default 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.
Facts POST /v1/notification-digests
Rate limit required | Tier 2 (100 requests per minute) |
Request Body POST /v1/notification-digests
application/json | The notification digest create request definition. |
Responses POST /v1/notification-digests
201 application/json | Notification digest was successfully created. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
500 application/json | Internal server error. |
default 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.
Facts PATCH /v1/notification-digests
Rate limit required | Tier 2 (100 requests per minute) |
Request Body PATCH /v1/notification-digests
application/json | The notification digest patch operations. |
Responses PATCH /v1/notification-digests
204 object | Notification digest was successfully updated. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
404 application/json | A notification digest with the specified ID was not found. |
500 application/json | Internal server error. |
default 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.
Facts DELETE /v1/notification-digests
Rate limit required | Tier 2 (100 requests per minute) |
Responses DELETE /v1/notification-digests
204 object | The notification digest has been successfully deleted. |
400 application/json | The specified digest ID is invalid (e.g. not a number). |
404 application/json | A notification digest with the specified ID was not found. |
500 application/json | Internal server error. |
default 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.
Facts GET /v1/notification-digests/{digestId}
Rate limit required | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/notification-digests/{digestId}
digestId required string | The notification digest task identifier. |
Responses GET /v1/notification-digests/{digestId}
200 application/json | Notification digest was successfully returned. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
404 application/json | digest not found. |
500 application/json | Internal server error. |
default 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.
Facts PATCH /v1/notification-digests/{digestId}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters PATCH /v1/notification-digests/{digestId}
digestId required string | The notification digest task identifier. |
Request Body PATCH /v1/notification-digests/{digestId}
application/json | The notification digest patch operations. |
Responses PATCH /v1/notification-digests/{digestId}
204 object | Notification digest was successfully updated. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
404 application/json | A notification digest with the specified ID was not found. |
500 application/json | Internal server error. |
default 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.
Facts DELETE /v1/notification-digests/{digestId}
Rate limit required | Tier 2 (100 requests per minute) |
Path Parameters DELETE /v1/notification-digests/{digestId}
digestId required string | The notification digest task identifier. |
Responses DELETE /v1/notification-digests/{digestId}
204 object | The notification digest has been successfully deleted. |
400 application/json | The specified digest ID is invalid (e.g. not a number). |
404 application/json | A notification digest with the specified ID was not found. |
500 application/json | Internal server error. |
default 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.
Facts GET /v1/notification-digests/{digestId}/executions
Rate limit required | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/notification-digests/{digestId}/executions
digestId required string | The notification digest task identifier. |
Query Parameters GET /v1/notification-digests/{digestId}/executions
limit default=100, minimum=1, maximum=100 integer | Limit the returned result set |
offset integer | Offset for finding a list of entities - used for pagination |
page string | The cursor to the page of data. |
workflowId string | The workflow Id for a specific digest |
next deprecated string | The cursor to the next page of data. Only one of next or previous may be specified. |
prev deprecated string | No description |
Responses GET /v1/notification-digests/{digestId}/executions
200 application/json | Notification digest executions were successfully returned. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
500 application/json | Internal server error. |
default 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.
Facts GET /v1/notification-digests/{digestId}/executions/{executionId}
Rate limit required | Tier 1 (1000 requests per minute) |
Path Parameters GET /v1/notification-digests/{digestId}/executions/{executionId}
digestId required string | The notification digest task identifier. |
executionId required string | The notification digest task identifier. |
Responses GET /v1/notification-digests/{digestId}/executions/{executionId}
200 application/json | Notification digest executions were successfully returned. |
400 application/json | Bad request, malformed syntax or errors in parameters. |
404 application/json | execution not found. |
500 application/json | Internal server error. |
default 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 required string | The operation to be performed. Enum: replace remove add |
path required string | The path for the given resource field to patch. |
value object | The value to be used for this operation. |
Error
objectProperties
code string | Error code specific to sharing service. |
meta | No description |
title string | Error title. |
detail string | Error cause. |
Error_meta
objectProperties
httpCode integer | HTTP error code. |
Errors
objectProperties
errors | No description |
traceId string | No description |
JsonPatch
objectProperties
op required string | The operation to be performed. Enum: replace remove add |
path required string | The path for the given resource field to patch. |
value object | The value to be used for this operation. |
ListLinks
objectProperties
next | No description |
prev | No description |
self | Object with Href to a particular element or set of elements |
NotificationDigest
objectProperties
id string | id of digest |
enabled boolean | Whether the digest is enabled or not |
ownerId string | Owner of the execution |
tenantId string | The tenant that this execution belongs to |
timezone string | the timezone for the chronos job |
frequency string | RRULE for SCHEDULED digest, as specified in RFC5545. |
startTime string | start time of the notification request |
chronosJobId string | The chronos job identifier. It is set once the related chronos job is created. |
currentWorkflowId string | current workflowID to be written in the executions |
NotificationDigestCreateRequest
objectProperties
enabled boolean | Whether the digest is enabled or not |
frequency string | RRULE for SCHEDULED digest, as specified in RFC5545. |
NotificationDigestExecution
objectNotification Digest Execution.
Properties
id string | id of execution |
content object | digest buffer content received from notification-prep |
ownerId string | Owner of the execution |
expireAt string | Timestamp for TTL document deleted after time stamp is reached |
tenantId string | The tenant that this execution belongs to |
resourceId string | resourceId for the digest execution |
workflowId string | workflow Id of related digest |
dateCreated string | Timestamp for the creation of the task execution |
resourceType string | resourceId for the digest execution |
secureContent object | digest buffer secure content received from notification-prep |
executionFlowStartTime string | Timestamp of execution start |
NotificationDigestExecutions
list of Notification Digest Executions.
Properties
totalCount integer | total count of entries in the collection as a whole |
currentPageCount integer | count of entries on the currently shown page |
links | No description |
executions | No description |
Page
objectProperties
href string | URL to particular set of elements |
type string | Page type, can be next or prev Enum: prev next |
token string | Page unique token |
Self
objectObject with Href to a particular element or set of elements
Properties
href string | No description |
StandardListResponseProps
objectproperties that should be added to every list response
Properties
totalCount required integer | total count of entries in the collection as a whole |
currentPageCount required integer | count of entries on the currently shown page |