NotificationDTO¶
Example Json Object
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "title": "string",
6 "forUserId": "string",
7 "byUserId": "string",
8 "message": "string",
9 "redirectTo": "string",
10 "displayId": "string",
11 "createdTime": "string",
12 "type": "string",
13 "read": true
14}
📄 Description: Data transfer object representing a notification, encapsulating essential details such as message content, recipient information, and delivery status to facilitate effective communication within business processes.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
id |
integer(int64) |
false |
none |
Unique identifier for the resource |
createdBy |
string |
false |
none |
Username of who created this resource |
createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
title |
string |
false |
none |
Title of the resource |
forUserId |
string |
false |
none |
Unique identifier for the for user |
byUserId |
string |
false |
none |
Unique identifier for the by user |
message |
string |
false |
none |
Contains the notification message that provides users with relevant updates or alerts within the system. |
redirectTo |
string |
false |
none |
Specifies the URL to which users will be redirected after a notification is processed, facilitating seamless navigation within the application. |
displayId |
string |
false |
none |
Unique identifier for the display |
createdTime |
string |
false |
none |
Time of the created |
type |
string |
false |
none |
Type of the resource |
read |
boolean |
false |
none |
Indicates whether the notification has been read by the user, facilitating effective communication tracking within the system. |