notifications
Protocol buffer definition for notifications
sift/notifications/v1/notifications.proto
BatchUpdateNotificationsRequest
The request for a call to NotificationService_BatchUpdateNotifications to update notifications.
A maximum of 1000 notifications can be modified in a batch.
| Field | Type | Label | Description |
|---|---|---|---|
| requests | UpdateNotificationRequest | repeated |
BatchUpdateNotificationsResponse
The response of a call to NotificationService_BatchUpdateNotifications containing the updated notifications.
| Field | Type | Label | Description |
|---|---|---|---|
| notifications | Notification | repeated | The updated notifications. |
ListNotificationsRequest
The request for a call to NotificationService_ListNotifications to retrieve notifications.
| Field | Type | Label | Description |
|---|---|---|---|
| page_size | uint32 | The maximum number of notifications to return. The service may return fewer than this value. If unspecified, at most 50 notifications will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. | |
| page_token | string | A page token, received from a previous ListNotifications call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListNotifications must match the call that provided the page token. | |
| filter | string | A Common Expression Language (CEL) filter string. Available fields to filter by are notification_id, created_by_user_id, recipient_user_id, created_date, notification_type, and is_read. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional. |
ListNotificationsResponse
The response of a call to NotificationService_ListNotifications.
| Field | Type | Label | Description |
|---|---|---|---|
| notifications | Notification | repeated | |
| next_page_token | string |
Notification
| Field | Type | Label | Description |
|---|---|---|---|
| notification_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| organization_id | string | ||
| recipient_user_id | string | ||
| is_read | bool | ||
| full_link | string | ||
| notification_type | NotificationKind | ||
| contents | string | ||
| entity_id | string |
UpdateNotificationRequest
| Field | Type | Label | Description |
|---|---|---|---|
| notification | Notification | The notification to update. The notification's notification_id field is used to identify the notification to update and must be provided. | |
| update_mask | google.protobuf.FieldMask | The list of fields to be updated. Currently, the only field that can be updated is is_read. |
NotificationKind
| Name | Number | Description |
|---|---|---|
| NOTIFICATION_KIND_UNSPECIFIED | 0 | |
| NOTIFICATION_KIND_TEXT | 1 | |
| NOTIFICATION_KIND_ANNOTATION_ASSIGNED | 2 | |
| NOTIFICATION_KIND_MENTIONED_IN_ANNOTATION_COMMENT | 3 | |
| NOTIFICATION_KIND_CONDITION_TRIGGERED | 4 | |
| NOTIFICATION_KIND_ANNOTATION_STATE_CHANGED | 5 | |
| NOTIFICATION_KIND_REPORT_READY | 6 | |
| NOTIFICATION_KIND_DATA_EXPORT_READY | 7 |
NotificationService
| Method Name | Request Type | Response Type | Description |
|---|---|---|---|
| ListNotifications | ListNotificationsRequest | ListNotificationsResponse | Retrieves notifications using an optional filter. |
| BatchUpdateNotifications | BatchUpdateNotificationsRequest | BatchUpdateNotificationsResponse | Batch updates a list of notifications using the list of fields specified in their respective update_masks. |