カテゴリー内の他の記事

通知の登録(POST)

Index

通知の登録

通知を登録することができます。

HTTP メソッド

POST

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以降

必要なアクセス権

通知を登録するアプリケーションの利用権限

※アプリケーション管理の API の外部通知を有効にしてください。
設定方法は、Garoon ヘルプ - API の外部通知の設定 クラウド版パッケージ版 をご確認ください。

リクエストの例

POST /g/api/v1/notification/items HTTP/1.1
Host: {subdomain}.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
  • Content-Type に application/json を指定してください。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。

リクエストボディ

パラメータ 指定する値 必須 説明
app 文字列 必須

外部通知コード

API の外部通知の設定で、「外部通知コード」に設定した値を指定します。
設定方法は、Garoon ヘルプ - API の外部通知の設定 クラウド版パッケージ版 をご確認ください。

notificationKey 文字列 必須

通知キー

複数のユーザーに対して通知を作成する場合、このキーはすべてのユーザーで同じです。
過去に登録した通知と同じ値の Key を指定すると、その通知が更新されます。

operation 文字列 必須

通知操作の概要

通知の種類を表す項目です。次のいずれかの値を指定します。

  • add
    新規通知データとして、外部通知を登録する場合
  • modify
    更新通知データとして、外部通知を登録する場合
  • remove
    削除通知データとして、外部通知を登録する場合
url 文字列 必須

通知に含まれる URL

API の外部通知の設定の「許可する URL」に、指定する URL を設定してください。
設定方法は、Garoon ヘルプ - API の外部通知の設定 クラウド版パッケージ版 をご確認ください。

title 文字列 必須 通知タイトル
body 文字列 必須 通知本文
icon 文字列 省略可

通知アイコン

URL 指定のみ可能です。
API の外部通知の設定の「許可する URL」に、指定する URL を設定してください。
設定方法は、Garoon ヘルプ - API の外部通知の設定 クラウド版パッケージ版 をご確認ください。
省略した場合、ベルの形のアイコンが通知アイコンとして設定されます。

destinations 配列 必須 通知先のリスト
destinations[].type 文字列 必須

通知先のタイプ
次の値を指定します。

  • USER
destinations[].id 数値 条件必須

通知先の Garoon ユーザー ID
※ id または code が必須です

destinations[].code 文字列 条件必須

通知先の Garoon ユーザー名(ログイン名)
※ id または code が必須です。

レスポンスの例

処理が成功すると、通知の内容が JSON 形式で返されます。

プロパティ

プロパティ名 説明
moduleId 文字列 Garoon のユーザー ID
creator.id 数値 通知の作成者の Garoon ユーザー ID
creator.code 文字列 通知の作成者の Garoon ユーザー名
creator.name 文字列 通知の作成者の Garoon ユーザーログイン名
createdAt 文字列 通知の作成日時
operation 文字列

通知操作の概要

通知の種類を表す項目です。

  • add
    新規通知データとして、外部通知を登録した場合
  • modify
    更新通知データとして、外部通知を登録した場合
  • remove
    削除通知データとして、外部通知を登録した場合
url 文字列 通知に含まれる URL
title 文字列 通知タイトル
body 文字列 通知本文
icon 文字列 通知アイコン
isRead 真偽値 通知が既読かどうか

JavaScript サンプル

Garoon REST API

XMLHttpRequest

制限事項

共通仕様の制限事項 をご確認ください。

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。