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

目次

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

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

URL

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

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

HTTPメソッド

GET

必要なアクセス権

  • アプリ管理権限

リクエスト

パラメーター
パラメーター名 必須 説明
app 数値または文字列 必須 アプリID
リクエストの例(URLにパラメーターを含める場合)
URL

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

ヘッダー
1
2
3
{
  "X-Cybozu-API-Token": "API_TOKEN"
}

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

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

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

ヘッダー
1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}
ボディ
1
2
3
{
  "app": "1"
}

レスポンス

プロパティ
プロパティ名 説明
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 文字列 アプリの設定のリビジョン番号
レスポンスの例
 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"
}

サンプルコード

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