レコードの条件通知の設定を取得する

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

レコードの条件通知の設定を取得します。

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

リクエストパラメーター

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

パラメーター名	型	必須	説明
app	数値または文字列	必須	アプリID
lang	文字列	省略可	取得する名称の言語選択式のフィールドで、選択肢の項目に言語ごとの名称を設定している場合に指定します。言語ごとの名称 `ja`：日本語 `en`：英語 `zh`：中国語 `user`：APIを実行するユーザーが表示言語に設定している言語言語設定が「Webブラウザーの設定に従う」の場合、「Accept-Language」ヘッダーの有無によって、取得する言語が変わります。ヘッダーあり：「Accept-Language」ヘッダーで指定した言語ヘッダーなし：cybozu.com共通管理のロケールの設定で設定した言語ロケールの設定 `default`：デフォルト省略すると、デフォルトの名称を取得します。

レスポンスプロパティ

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

プロパティ名	型	説明
notifications	配列	条件通知の設定の一覧
notifications[].filterCond	文字列	レコードの条件クエリ形式で表されます。クエリ形式の詳細は次のページを参照してください。クエリの書き方
notifications[].title	文字列	通知内容
notifications[].targets	配列	通知先の対象の一覧
notifications[].targets[].entity	オブジェクト	通知先の対象
notifications[].targets[].entity.type	文字列	通知先の対象の種類 `USER`：ユーザー `GROUP`：グループ `ORGANIZATION`：組織 `FIELD_ENTITY`：「フォームのフィールドを追加」で指定したフィールド作成者更新者ユーザー選択組織選択グループ選択
notifications[].targets[].entity.code	文字列	通知先の対象のコード `entity.type`の値によって異なります。「USER」の場合：ユーザーのログイン名「GROUP」の場合：グループコード「ORGANIZATION」の場合：組織コード「FIELD_ENTITY」の場合：「フォームのフィールドを追加」で指定したフィールドのフィールドコードゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
notifications[].targets[].includeSubs	真偽値	設定を下位組織に継承するかどうか `true`：継承する `false`：継承しない `entity.type`の値が「ORGANIZATION」か、「FIELD_ENTITY」で組織選択フィールドが指定されている場合、「true」が返ります。
revision	文字列	アプリの設定のリビジョン番号

必要なアクセス権

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

アプリ管理権限

サンプル

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

サンプルリクエスト

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

1

https\://sample.cybozu.com/k/v1/app/notifications/perRecord.json?app=8&lang=ja

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

1
2
3


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

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

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

1

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

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

1
2
3
4


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

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

リクエストボディ

1
2
3
4


{
  "app": "8",
  "lang": "ja"
}

サンプルレスポンス

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


{
  "notifications": [
    {
      "filterCond": "ユーザー選択_0 in (\"user1\")",
      "title": "user1が選択されました",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "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/perRecord.json'), '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/perRecord.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": "8"
  }'

kintone API

kintone APIドキュメント

レコードの条件通知の設定を取得する

目次

リクエストパラメーター

レスポンスプロパティ

必要なアクセス権

サンプル