Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

notification-controller

Get notification request preview (getNotificationRequestPreview)

Returns preview for notification request.

processedTemplates shows how the notifications for each delivery method will look like for the first recipient of the corresponding notification target.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

post/api/notification/request/preview

Query parameters

recipientsPreviewSizeinteger

Amount of the recipients to show in preview

Request body

targetsstring[] required
status'PROCESSING' | 'SENT' | 'SCHEDULED'
createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

Example request

{
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "templateId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_TEMPLATE"
  },
  "template": {
    "id": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "NOTIFICATION_TEMPLATE"
    },
    "createdTime": 1746028547220,
    "tenantId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "TENANT"
    }
  },
  "info": {
    "dashboardId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "DASHBOARD"
    },
    "stateEntityId": {
      "id": "784f394c-42b6-435a-983c-b7beff2784f9",
      "entityType": "DEVICE"
    }
  },
  "originatorEntityId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "ruleId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_RULE"
  },
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "NOTIFICATION_REQUEST"
  },
  "createdTime": 1746028547220
}

Response

OK

processedTemplatesobject
totalRecipientsCountinteger
recipientsCountByTargetobject
recipientsPreviewstring[]