Garoon API ドキュメント

通知を取得する

目次

通知を取得する

固定リンクがコピーされました

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

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST API の共通仕様 を参照してください。

ボディ
1
2
3

{
  "limit": 30
}

レスポンス

固定リンクがコピーされました

プロパティ
プロパティ名 型 説明
items[].moduleId 文字列 通知のアプリケーション ID
  • grn.schedule：スケジュール
  • grn.message：メッセージ
  • grn.bulletin：掲示板
  • grn.cabinet：ファイル管理
  • grn.phonemessage：電話メモ
  • grn.mail：メール
  • grn.workflow：ワークフロー
  • grn.report：マルチレポート
  • grn.space：スペース
  • grn.space.discussion：スペースのディスカッション
  • grn.space.todo：スペースの共有 ToDo
  • Cybozu Information：サイボウズからのお知らせ
  • x.n：外部通知
    n は数字で、外部通知の設定（ クラウド版 (External link) ｜ パッケージ版 (External link) ）で設定した順の連番です。
items[].creator.id 数値 通知の作成者の Garoon のユーザー ID
items[].creator.code 文字列 通知の作成者の Garoon のユーザー名
パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。
詳細は ユーザー情報の項目を変更する (External link) を参照してください。
items[].creator.name 文字列 通知の作成者の Garoon のユーザーログイン名
items[].createdAt 文字列 通知の作成日時
items[].operation 文字列 通知の種類
  • add：新規通知データとして、外部通知を登録する
  • modify：更新通知データとして、外部通知を登録する
  • remove：削除通知データとして、外部通知を登録する
items[].url 文字列 通知に含まれる URL
items[].title 文字列 通知のタイトル
items[].body 文字列 通知の本文
items[].icon 文字列 通知のアイコン
items[].isRead 真偽値 通知が既読かどうか
  • true：既読
  • false：未読
hasNext 真偽値 次の通知があるかどうか
  • true：次の通知がある
  • false：次の通知がない
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

{
  "items": [
    {
      "moduleId": "grn.space.discussion",
      "creator": {
        "id": "1",
        "code": "c000001",
        "name": "Noboru Satoh(Satoh Noboru); Sales Department"
      },
      "createdAt": "2022-09-29T06:25:18Z",
      "operation": "add",
      "url": "https://sample.cybozu.com/g/space/application/discussion/index.csp?spid=1",
      "title": "Developmennt schedule discussion",
      "body": "06/20 - 09/11：Development\\r\\n10/01：Release",
      "icon": "https://example.com/sample-icon.svg",
      "isRead": false
    }
  ],
  "hasNext": false
}

サンプルコード

固定リンクがコピーされました

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/notification/items' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST API リクエストを送信する API を使ったリクエスト
1
2
3
4
5

const body = {
  limit: 30
};

await garoon.api('/api/v1/notification/items', 'GET', body);