kintone API ドキュメント

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

目次

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

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

URL

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

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/notifications/perRecord.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/app/notifications/perRecord.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/notifications/perRecord.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/preview/app/notifications/perRecord.json

HTTPメソッド

GET

必要なアクセス権

  • アプリ管理権限

リクエスト

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

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

ヘッダー
1
2
3

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

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

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

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

ヘッダー
1
2
3
4

{
  "X-Cybozu-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
ボディ
1
2
3
4

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

レスポンス

プロパティ
プロパティ名 型 説明
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 文字列 アプリの設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

{
  "notifications": [
    {
      "filterCond": "ユーザー選択フィールド in (\"user1\")",
      "title": "user1が選択されました",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "revision": "2"
}

サンプルコード

curl を使ったリクエスト
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 REST API リクエストを送信する 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);