アプリの条件通知の設定を取得する

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

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

HTTPメソッド	GET
URL	https://sample.cybozu.com/k/v1/app/notifications/general.json
URL（ゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/app/notifications/general.json
URL（動作テスト環境）	https://sample.cybozu.com/k/v1/preview/app/notifications/general.json
URL（動作テスト環境のゲストスペース）	https://sample.cybozu.com/k/guest/`GUEST_SPACE_ID`/v1/preview/app/notifications/general.json
認証	パスワード認証 , APIトークン認証 , セッション認証 , OAuth認証
Content-Type	application/json（クエリ文字列でクエリを指定する場合は不要）

リクエストパラメーター

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

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID

レスポンスプロパティ

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

プロパティ名	型	説明
notifications	配列（オブジェクト）	条件通知の設定を表すオブジェクトの配列
notifications[].entity	オブジェクト	条件通知の設定の対象を表すオブジェクト
notifications[].entity.type	文字列	条件通知の設定対象の種類 `USER`：ユーザー `GROUP`：グループ `ORGANIZATION`：組織 `FIELD_ENTITY`：「フォームのフィールドを追加」で指定したフィールド作成者更新者ユーザー選択組織選択グループ選択
notifications[].entity.code	文字列	条件通知の設定対象のコード `entity.type`の値によって異なります。「USER」の場合：ユーザーのログイン名「GROUP」の場合：グループコード「ORGANIZATION」の場合：組織コード「FIELD_ENTITY」の場合：「フォームのフィールドを追加」で指定したフィールドのフィールドコードゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
notifications[].includeSubs	真偽値	設定を下位組織に継承するかどうか `true`：継承する `false`：継承しない `entity.type`の値が「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ、「true」が返ります。
notifications[].recordAdded	真偽値	レコード追加で通知するかどうか `true`：レコード追加で通知する `false`：レコード追加で通知しない
notifications[].recordEdited	真偽値	レコード編集で通知するかどうか `true`：レコード編集で通知する `false`：レコード編集で通知しない
notifications[].commentAdded	真偽値	コメントの書き込みで通知するかどうか `true`：コメントの書き込みで通知する `false`：コメントの書き込みで通知しない
notifications[].statusChanged	真偽値	ステータスの更新で通知するかどうか `true`：ステータスの更新で通知する `false`：ステータスの更新で通知しない
notifications[].fileImported	真偽値	ファイル読み込みで通知するかどうか `true`：ファイル読み込みで通知する `false`：ファイル読み込みで通知しない
notifyToCommenter	真偽値	コメントを書き込んだユーザーが、そのレコードにコメントが書き込まれたときに通知を受信するかどうか `true`：コメントが書き込まれたときに通知を受信する `false`：コメントが書き込まれたときに通知を受信しない
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

リクエストURL（URLにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/notifications/general.json?app=1

リクエストヘッダー（URLにパラメーターを含める場合）

1
2
3


{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

リクエストURL（リクエストボディにパラメーターを含める場合）

1

https\://sample.cybozu.com/k/v1/app/notifications/general.json

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

1
2
3
4


{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

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

リクエストボディ

1
2
3


{
  "app": "1"
}

サンプルレスポンス

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18


{
  "notifications": [
    {
      "entity": {
        "type": "USER",
        "code": "user1"
      },
      "includeSubs": false,
      "recordAdded": true,
      "recordEdited": true,
      "commentAdded": false,
      "statusChanged": false,
      "fileImported": true
    }
  ],
  "notifyToCommenter": true,
  "revision": "2"
}

サンプルコード

kintone.api()を使ったリクエスト

kintone.api()の詳細は、次のページを参照してください。
kintone REST APIリクエストを送信する

1
2
3
4
5


const body = {
  app: kintone.app.getId()
};

await kintone.api(kintone.api.url('/k/v1/app/notifications/general.json', true), 'GET', body);

curlを使ったリクエスト

ご利用の環境によって、curlのフォーマットは異なる場合があります。
詳細は、次のページを参照してください。
curlコマンドでkintone REST APIを実行してみよう/3.API実行

1
2
3
4
5
6


curl -X GET 'https://sample.cybozu.com/k/v1/app/notifications/general.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1
  }'

kintone API

kintone APIドキュメント

アプリの条件通知の設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル