通知を取得する
APIを実行したユーザーの未読の更新情報の通知を取得します。
HTTPメソッド
GET
URL
クラウド版
https://sample.cybozu.com/g/api/v1/notification/items
パッケージ版
環境に合わせてそれぞれ以下を置き換えてください。
IP_ADDRESS_OR_HOST_NAME
:Garoonのインストール先のIPアドレスまたはホスト名INSTALL_IDENTIFER
:Garoonのインストール識別子
- Windows環境
- http://
IP_ADDRESS_OR_HOST_NAME
/scripts/INSTALL_IDENTIFER
/grn.exe/api/v1/notification/items - Linux環境
- http://
IP_ADDRESS_OR_HOST_NAME
/cgi-bin/INSTALL_IDENTIFER
/grn.cgi/api/v1/notification/items
利用できるバージョン
- クラウド版Garoon
- パッケージ版Garoon 5.0以降
必要なアクセス権
- 通知を取得するアプリケーションの利用権限
リクエスト
パラメーター
リクエストパラメーターは、URLクエリパラメーターとして送信してください。
ただし、
Garoon REST APIリクエストを送信するAPIを使って実行する場合は、リクエストボディとして指定できます。
パラメーター名 | 型 | 必須 | 説明 |
---|---|---|---|
fields | 文字列 | 省略可 | 取得するitems 内のプロパティ複数のプロパティを指定するには、半角カンマで区切ります。 |
limit | 数値 | 省略可 | 取得する通知の件数 1から1,000まで指定できます。省略すると100が設定されます。 指定された条件に一致する通知がさらにある場合でも、指定した値より取得できる通知の数は少なくなる可能性があります。 |
offset | 数値 | 省略可 | 取得する通知の先頭からスキップする数 省略すると、0が設定されます。 |
リクエストの例
URL
https://sample.cybozu.com/g/api/v1/notification/items
ヘッダー
|
|
リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。
ボディ
|
|
レスポンス
プロパティ
プロパティ名 | 型 | 説明 |
---|---|---|
items[].moduleId | 文字列 | 通知のアプリケーションID |
items[].creator.id | 数値 | 通知の作成者のGaroonユーザーID |
items[].creator.code | 文字列 | 通知の作成者のGaroonのユーザー名 パッケージ版Garoonの場合、ログイン名を公開する設定が必要です。 詳細は ユーザー情報の項目を変更する を参照してください。 |
items[].creator.name | 文字列 | 通知の作成者のGaroonのユーザーログイン名 |
items[].createdAt | 文字列 | 通知の作成日時 |
items[].operation | 文字列 | 通知の種類
|
items[].url | 文字列 | 通知に含まれるURL |
items[].title | 文字列 | 通知のタイトル |
items[].body | 文字列 | 通知の本文 |
items[].icon | 文字列 | 通知のアイコン |
items[].isRead | 真偽値 | 通知が既読かどうか
|
hasNext | 真偽値 | 次の通知があるかどうか
|
レスポンスの例
|
|
サンプルコード
curlを使ったリクエスト
|
|
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
|
|