Connect REST API 開発者ガイド
j通知
コンテキストユーザが GET 要求を行うと、API はコンテキストユーザの通知を返します。API は、要求元の接続アプリケーションのコンテキストを使用して、該当する種別の通知を返します。
接続アプリケーションが GET 要求を行った場合、API は、組織レベルの設定が適用された、接続アプリケーションが登録している種別のカスタム通知のみを返します。たとえば、システム管理者がアプリケーションの特定の通知種別を無効にした場合、API は、その種別の通知を返しません。
サードパーティ (接続アプリケーションではない) が GET 要求を行った場合、API は、デスクトップで有効な種別のカスタム通知のみを返します。
- リソース
- /connect/notifications
- 適用開始バージョン
- 49.0
- Chatter が必要かどうか
- いいえ
- HTTP のメソッド
- GET、PATCH
- GET の要求パラメータ
-
パラメータ 戻り値 説明 必須か省略可能 使用可能なバージョン after String この ISO 8601 形式の日付文字列の後に発生した通知を既読、未読、表示、または未表示としてマークします。 このパラメータと before パラメータを併用することはできません。
省略可能 49.0 before String この ISO 8601 形式の日付文字列の前に発生した通知を既読、未読、表示、または未表示としてマークします。指定されていない場合、デフォルトは現在の日付と時刻です。 省略可能 49.0 size Integer 返される通知の数。値の範囲は 1 ～ 20 です。20 を超える数値を指定しても、返される通知は 20 件のみです。指定されていない場合、デフォルトは 20 です。 省略可能 49.0 trimMessages Boolean 通知の内容を切り詰めるか (true)、全文を表示するか (false) を示します。true の場合、通知のタイトルには 120 文字までが表示され、本文には最大 320 文字までが表示されます。false の場合、通知のタイトルには 250 文字までが表示され、本文には 750 文字までが表示されます。指定されていない場合、デフォルトは true です。 省略可能 50.0 - PATCH のリクエストボディ
-
- ルート XML タグ
- <notifications>
- JSON の例
-
- プロパティ
-
- PATCH の要求パラメータ
-
パラメータ 戻り値 説明 必須か省略可能 使用可能なバージョン before String この ISO 8601 形式の日付文字列の前に発生した通知を既読、未読、表示、または未表示としてマークします。指定されていない場合、デフォルトは現在の日付と時刻です。 省略可能 49.0 notificationIds String[] 既読、未読、表示、または未表示としてマークする最大 50 個の通知 ID のリスト。 省略可能 49.0 read Boolean 通知を既読 (true) または未読 (false) としてマークします。 通知が既読としてマークされている場合、その通知は、表示としてもマークされます。read を true に設定し、seen を false に設定した場合は、エラーが表示されます。
seen が指定されていない場合は必須 49.0 seen Boolean 通知を表示 (true) または未表示 (false) としてマークします。 read が指定されていない場合は必須 49.0 - GET および PATCH のレスポンスボディ
- Notification Collection