kintone APIドキュメント

リマインダーの条件通知の設定を取得する

目次

リマインダーの条件通知の設定を取得する

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

リマインダーの条件通知の設定を取得します。

URL

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

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

運用環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/app/notifications/reminder.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/app/notifications/reminder.json
動作テスト環境の設定を取得する場合
通常のアプリ
https://sample.cybozu.com/k/v1/preview/app/notifications/reminder.json
ゲストスペースのアプリ
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/preview/app/notifications/reminder.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/reminder.json?app=1&lang=ja

ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

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

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

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

ヘッダー
1
2
3
4

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

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

レスポンス

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

プロパティ
プロパティ名 型 説明
notifications 配列 リマインダーの条件通知の設定
notifications[].timing オブジェクト 通知のタイミング
notifications[].timing.code 文字列 通知のタイミングの基準日時となるフィールドのフィールドコード
notifications[].timing.daysLater 文字列 基準日時から何日前または何日後に通知するか
基準日時より前に通知する場合は、負の整数が返ります。
notifications[].timing.hoursLater 文字列 基準日時にtiming.daysLaterを足した日時から、何時間後または何時間前に通知するか
timing.codeに日時を表すフィールドを指定し「相対時刻を指定」が設定されている場合に値が返ります。
基準日時より前の場合は、負の整数が返ります。
notifications[].timing.time 文字列 基準日時にtiming.daysLaterを足した日付から、いつ通知するか
次のいずれかの場合に値が返ります。
  • timing.codeに日付フィールドを設定している場合
  • timing.codeに日時を表すフィールドを指定し「絶対時刻を指定」が設定されている場合
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」で組織選択フィールドが指定されている場合のみ 「false」が返ります。
timezone 文字列 リマインドする時刻のタイムゾーン
リマインダーの条件通知を一度も設定していないアプリでは 「null」が返ります。
revision 文字列 アプリ設定のリビジョン番号
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

{
  "notifications": [
    {
      "timing": {
        "code": "作成日時",
        "daysLater": "1",
        "hoursLater": "2"
      },
      "filterCond": "ユーザー選択_0 in (\"user1\")",
      "title": "リマインドです",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    },
    {
      "timing": {
        "code": "作成日付",
        "daysLater": "-3",
        "time": "08:30"
      },
      "filterCond": "ユーザー選択_0 in (\"user1\")",
      "title": "リマインドです",
      "targets": [
        {
          "entity": {
            "type": "USER",
            "code": "user1"
          },
          "includeSubs": false
        }
      ]
    }
  ],
  "timezone": "Asia/Tokyo",
  "revision": "2"
}

サンプルコード

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

curlを使ったリクエスト
1
2
3
4
5
6
7

curl -X GET 'https://sample.cybozu.com/k/v1/app/notifications/reminder.json' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
-H 'Content-Type: application/json' \
-d '{
  "app": 1,
  "lang": "ja"
}'
kintone.api()を使ったリクエスト

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

1
2
3
4
5
6

const body = {
  app: kintone.app.getId(),
  lang: 'ja'
};

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