プロパティ
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| id | integer | ID | ○ |
| title | string | 通知タイトル 例：予定「○○」を変更しました | ○ |
| body | string | 本文 | ○ |
| type | string | タイプ*1 | ○ |
| category | string | 通知する機能のカテゴリー*2 | ○ |
| is_system_notify | boolean | システム通知か ※アカウント所属時に通知される「ようこそ」や、Googleカレンダーへの反映失敗など、通知者がいない通知の場合は true になる | ○ |
| is_read | boolean | 認可ユーザーが既読か | ○ |
| notifier | User | 通知者情報 ※システム通知の場合は None を返す | ○ |
| target_id | integer | 通知内容であるインスタンスのID ※トピックIDや予定ID など | ○ |
| comment_id | integer | 通知内容がトピックの返信だった場合、返信されたコメントのID | ○ |
| notifications_count | integer | 子通知を含めた同じインスタンスの通知件数 ※リストの取得で「show_past_count=true」だった場合のみレスポンスに含まれる | ○ |
| unread_notifications_count | integer | 子通知を含めた同じインスタンスの未読通知件数 ※リストの取得で「show_past_count=true」だった場合のみレスポンスに含まれる | ○ |
| created_datetime | datetime | 通知日時 | ○ |
*1 typeでは以下の値を返します。
| 値 | 説明 |
|---|---|
| error | Googleカレンダーへの反映エラー、エントリーの公開予約エラー など |
| normal | エラー以外の通常の通知 |
*2 categoryでは以下の値を返します。
| 値 | 説明 |
|---|---|
| profile | プロフィール アカウント所属時に通知される「ようこそ」や、Googleカレンダーへの反映失敗 など |
| message | トピック トピックの作成、返信 など |
| event | 予定 予定の作成、変更、削除、Googleカレンダー同期エラーなど、予約を除く |
| task | タスク タスクの作成、変更、共有、削除、Googleカレンダー同期エラー など |
| user_file | ファイル（グループウェア） ファイルの追加、変更 など |
メソッド
| メソッド名 | HTTPメソッド | パス | 処理 |
|---|---|---|---|
| リスト | GET | /notifications/ | 認可スタッフの通知リストを返す ※同じインスタンスの最新の通知のみ |
| 過去の通知リスト | GET | /notifications/[notification_id]/past_notifications/ | 認可スタッフの指定された過去の通知リストを返す ※レスポンスには最新の通知も含む |
| 既読にする | POST | /notifications/[notification_id]/read/ | 指定された通知を既読に変更 |
関連リソース
特になし