Skip to main content

UserNotification

UserNotification

Field NULL Description Note
notificationMessageId
integer		  

The notification message type

  • 1 = ExportQueueFileCreated
  • 2 = ExportQueueFileReady
  • 3 = ExportQueueFileFailed
  • 4 = ProvisionMapStarted
  • 5 = ProvisionMapSuccessful
  • 6 = ProvisionMapError
  • 13 = ProvisionEncryptionDataStarted
  • 14 = ProvisionEncryptionDataSuccessful
  • 15 = ProvisionEncryptionDataError
  • 16 = BulkReportMigration
  
userId
string (GUID)		 Y The id of the user the notification is for  
assoicatedId
string (GUID)		 Y The id of the record the notification relates to, such as a report, dashboard, or export queue item The spelling is intentional. The server expects assoicatedId.
status
integer		  

Whether the user has read the notification

  • 0 = UnRead
  • 1 = Read
  
replaceValues
string		   Substitution values for the message template, as a serialized JSON object
Example: {"FileName": "Quarterly_Sales_Report.pdf"}		  

Inherited fields:

Entity

Field NULL Description Note
id
string (GUID)		   The id of this object
Example: 572bd576-8c92-4901-ab2a-b16e38144813 		Allow null incase insert a new entity
state
integer		  

The entity state of this object

  • 0 = None
  • 1 = Insert
  • 2 = Delete
  • 3 = Update
  
deleted
boolean		   Is this object deleted  
inserted
boolean		   Is this object inserted  
version
string		 Y The version  
created
datetime in ISO 8601 format		 Y The created datetime  
createdBy
string		   The creator  
modified
datetime in ISO 8601 format		 Y The modification datetime  
modifiedBy
string		   The user who last modified this object  
Sample:
{"id":"2c3d4e5f-6a7b-8e9f-0a1b-2c3d4e5f6a7b","notificationMessageId":2,"userId":"9d2f1d51-0e3d-44db-bfc7-da94a7581bfe","assoicatedId":"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d","status":0,"replaceValues":"{\"FileName\": \"Quarterly_Sales_Report.pdf\"}"}