検索
Close
カテゴリー内の他の記事

アプリの条件通知の取得

作成日
更新日

アプリの条件通知の設定を取得します。

URI

URIは、運用環境の設定を取得する場合と、動作テスト環境の設定を取得する場合とで異なります。

運用環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/app/notifications/general.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/app/notifications/general.json

動作テスト環境の設定を取得する場合

https://(サブドメイン名).cybozu.com/k/v1/preview/app/notifications/general.json

ゲストスペースのアプリの場合：https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/notifications/general.json

HTTPメソッド

GET

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリのIDを指定します。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」を指定したリクエストの例は、次のとおりです。

URLにパラメータを含める場合

GET /k/v1/app/notifications/general.json?app=8 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディにパラメーターを含める場合
ヘッダ

GET /k/v1/app/notifications/general.json HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

ボディ

レスポンスパラメータ

パラメータ名 値の種類 説明
notifications 配列 条件通知の設定を表すオブジェクトの配列です。
notifications[].entity オブジェクト 条件通知の設定の対象を表すオブジェクトです。
notifications[].entity.type 文字列 条件通知の設定対象の種類です。
  • USER：ユーザー
  • GROUP：グループ
  • ORGANIZATION：組織
  • FIELD_ENTITY：作成者・更新者・作業者・ユーザー選択・組織選択・グループ選択フィールド
notifications[].entity.code 文字列

条件通知の設定対象のコードです。
notifications[].entity.type の値に応じて、次の値が返却されます。

FIELD_ENTITY の場合：フィールドコード
それ以外の場合：条件通知の設定対象

ゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
notifications[].includeSubs 真偽値 設定を下位組織に継承するかどうかの設定です。
notifications[].entity.type の値が ORGANIZATION か FIELD_ENTITY で組織選択フィールドが指定されている場合以外、常にfalseが返却されます。
  • true：継承する
  • false：継承しない
notifications[].recordAdded 真偽値 レコード追加で通知するかどうかの設定です。
  • true：レコード追加で通知する
  • false：レコード追加で通知しない
notifications[].recordEdited 真偽値 レコード編集で通知するかどうかの設定です。
  • true：レコード編集で通知する
  • false：レコード編集で通知しない
notifications[].commentAdded 真偽値 コメントの書き込みで通知するかどうかの設定です。
  • true：コメントの書き込みで通知する
  • false：コメントの書き込みで通知しない
notifications[].statusChanged 真偽値

ステータスの更新で通知するかどうかの設定です。

  • true：ステータスの更新で通知する
  • false：ステータスの更新で通知しない
notifications[].fileImported 真偽値 ファイル読み込みで通知するかどうかの設定です。
  • true：ファイル読み込みで通知する
  • false：ファイル読み込みで通知しない
notifyToCommenter 真偽値 コメントを書き込んだユーザーが、そのレコードにコメントが書き込まれたときに通知を受信するかどうかの設定です。
  • true：コメントが書き込まれたときに通知を受信する
  • false：コメントが書き込まれたときに通知を受信しない
revision 文字列 アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

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

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

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