GeneralNotifications
Controls global notification settings for an app, allowing you to adjust how users are alerted about updates, mentions, or record activity.
Select
The AppId column is required in the WHERE clause. The driver will use the Kintone APIs to filter the results by this column. By default, the driver will process other filters client-side within the driver.
For example, the following queries are processed server side:
SELECT * FROM GeneralNotifications WHERE AppId = 6 SELECT * FROM GeneralNotifications WHERE AppId = 6 AND IsPreview = false
Update
For updating the GeneralNotifications, provide the Notifications as an aggregate. The AppId column is required to update the GeneralNotifications.
UPDATE GeneralNotifications SET Notifications = '[{"entity":{"type":"FIELD_ENTITY","code":"Updated_by"},"includeSubs":false,"recordAdded":false,"commentAdded":true}],"notifyToCommenter":true' WHERE AppId = 6
Columns
| Name | Type | ReadOnly | References | Description |
| AppId [KEY] | Integer | False |
Identifier of the Kintone app whose general notification settings are being retrieved or updated. | |
| EntityType | String | False |
Type of entity that receives the general notifications, such as a user, group, or department. | |
| EntityCode [KEY] | String | False |
Code identifying the specific entity configured to receive general notifications. | |
| IncludeSubs | Boolean | False |
Indicates whether notification rules assigned to a department should also apply to its subordinate departments, and always returns 'false' unless notifications[].entity.type is set to ORGANIZATION or FIELD_ENTITY for a Department Selection field. | |
| RecordAdded | Boolean | False |
Specifies whether the entity should receive a notification whenever a new record is added to the app. | |
| RecordEdited | Boolean | False |
Specifies whether the entity should receive a notification when an existing record is edited. | |
| CommentAdded | Boolean | False |
Specifies whether the entity should receive a notification when a new comment is posted on a record. | |
| StatusChanged | Boolean | False |
Specifies whether the entity should receive a notification when a record's status changes within a workflow. | |
| FileImported | Boolean | False |
Specifies whether the entity should receive a notification when data is imported into the app using a file. | |
| NotifyToCommenter | Boolean | False |
Specifies whether all commenters on a record should be notified when a new comment is added, reflecting the Send updated comment notifications to all commenters setting. | |
| Revision | String | True |
Revision number of the app settings, helping track changes made to notification rules. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| IsPreview | Boolean |
Indicates whether to retrieve general-notification details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Notifications | String |
Value used only when performing an update to supply modified general-notification settings. |