ApplicationSettingDTO¶
Example Json Object
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "settingGroup": "GENERAL_SETTING",
6 "captionKey": "string",
7 "settingValue": "string",
8 "inApp": true,
9 "email": true,
10 "settingComponentType": "TOGGLE"
11}
📄 Description: Data transfer object representing application settings, including configuration parameters and preferences that govern the behavior of the application within an enterprise environment.
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 |
settingGroup |
string |
false |
none |
Identifier for the group of application settings, facilitating organized management and retrieval of related configuration parameters. |
captionKey |
string |
false |
none |
Key used to retrieve the corresponding caption for application settings, facilitating consistent user interface messaging across the platform. |
settingValue |
string |
false |
none |
The settingValue field represents the specific configuration value associated with an application setting, enabling customization and optimization of application behavior. |
inApp |
boolean |
false |
none |
Indicates whether in-app features are enabled for the application, allowing for enhanced user engagement and functionality. |
boolean |
false |
none |
Indicates whether email notifications are enabled for application settings within the system. |
|
settingComponentType |
string |
false |
none |
Type of the setting component |
Enumerated Values
Attribute |
Value |
|---|---|
settingComponentType |
DATE, DROPDOWN, NUMBER, TEXT, TEXTAREA, TOGGLE |
settingGroup |
GENERAL_SETTING, NOTIFICATION_SETTING |