Index
通知の取得（クエリで条件を指定）
未読の通知に関する情報を取得します。
HTTP メソッド
GET
URI
クラウド版
https://(サブドメイン名).cybozu.com/g/api/v1/notification/items
パッケージ版（Windows環境）
以下は、ヘルプに記載している Windows のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/scripts/(インストール識別子)/grn.exe/api/v1/notification/items
パッケージ版（Linux環境）
以下は、ヘルプに記載している Linux のディレクトリー構成でインストールしたときの例です。インストールするディレクトリーを変更している場合は、パスを読み替えてください。
http://(サーバーのIPアドレスまたはホスト名)/cgi-bin/(インストール識別子)/grn.cgi/api/v1/notification/items
使用可能なガルーンのバージョン
- クラウド版 Garoon
- パッケージ版 Garoon バージョン 5.0.0以降
必要なアクセス権
通知を取得するアプリケーションの利用権限
リクエストパラメータ
| パラメータ名 | 指定する値 | 必須 | 説明 |
|---|---|---|---|
| limit | 数値 |
省略可 |
取得する通知の制限数を指定します。 要求パラメータで指定された条件に一致する通知がさらにある場合でも、通知数は指定した値より少なくなる可能性があります。 デフォルト値 ：100 |
| offset | 数値 | 省略可 |
取得する通知の先頭からスキップする数を指定します。 |
| fields | 文字列 | 省略可 |
取得するitems内のプロパティを指定します。 |
リクエストの例
GET /g/api/v1/notification/items HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
- Content-Typeヘッダは不要です。
レスポンスの例
処理が成功すると、通知の内容がJSON形式で返されます。
プロパティ
| プロパティ名 | 型 | 説明 |
|---|---|---|
| items[].moduleId | 文字列 |
GaroonのモジュールのID |
| items[].creator.id |
数値 |
通知の作成者のGaroonのユーザーID |
|
items[].creator.code |
文字列 |
通知の作成者のGaroonのユーザー名 |
| items[].creator.name | 文字列 |
通知の作成者のGaroonのユーザーログイン名 |
| items[].createdAt | 文字列 |
通知の作成日時 |
| items[].operation | 文字列 |
通知操作の概要。
|
| items[].url | 文字列 |
通知に含まれるURL |
| items[].title | 文字列 |
通知タイトル |
| items[].body | 文字列 |
通知本文 |
| items[].icon | 文字列 |
通知アイコン |
| items[].isRead | 真偽値 |
通知が既読かどうか |
| hasnext | 真偽値 |
レスポンスに次の通知があるかどうか |
JavaScript サンプル
XMLHttpRequest
制限事項
共通仕様の制限事項 をご確認ください。
記事に関するフィードバック
記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。