カテゴリー内の他の記事

リマインダーの条件通知の変更

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

このAPI は、動作テスト環境のアプリに変更を反映します。
本番環境に変更を反映する場合、このAPI を実行した後に、アプリ設定の運用環境への反映 API を実行してください。

URI

https://(サブドメイン名).cybozu.com/k/v1/preview/app/notifications/reminder.json

ゲストスペースのアプリの場合

https://(サブドメイン名).cybozu.com/k/guest/(スペースの ID)/v1/preview/app/notifications/reminder.json

HTTP メソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値または文字列 必須 アプリのIDを指定します。
notifications 配列   条件通知の設定を表すオブジェクトの配列です。
空配列を指定した場合は、条件通知の設定を削除します。
省略した場合は変更されません。
notifications[].timing オブジェクト 条件必須 通知のタイミングを設定します。
「notifications」パラメータを指定する場合、必須です。
notifications[].timing.code 文字列 条件必須 通知のタイミングで設定する基準日時となるフィールドのフィールドコードを指定します。
「notifications[].timing」パラメータを指定する場合、必須です。
以下のフィールドのフィールドコードが指定可能です。
  • 作成日時
  • 更新日時
  • 日時
  • 日付
notifications[].timing.daysLater 数値または文字列 条件必須 基準日時から何日後(何日前)に通知するかの設定です。
「notifications[].timing」パラメータを指定する場合、必須です。
基準日時より前の場合は、負の整数を指定します。
指定できる値は -10000 以上 10000 以下の整数です。
notifications[].timing.hoursLater 数値または文字列 条件必須
※ notifications[].timing.time を指定する際には指定不可
基準日時に notifications[].timing.daysLater を足した日時から、何時間後(何時間前)に通知するかの設定です。
「notifications[].timing」パラメータを指定する場合、必須です。
基準日時より前の場合は、負の整数を指定します。
指定できる値は -10000 以上 10000 以下の整数です。
notifications[].timing.time 文字列 条件必須
※ notifications[].timing.hoursLater を指定する際には指定不可
基準日時に notifications[].timing.daysLater を足した日付の、何時に通知するかの設定です。
「notifications[].timing」パラメータを指定する場合、必須です。
フォーマットは、"HH:mm"(例: 09:20)で設定してください。
ただし、10 分単位の入力以外は指定できません。
notifications[].filterCond 文字列   リマインダーの条件通知を行う条件です。クエリ形式で設定します。
クエリ形式については、次のページを参考にしてください。
レコードの一括取得(クエリで条件を指定)
以下の場合は「すべてのレコード」を指定した場合と同じになる
  • 空文字を指定
  • null を指定
  • パラメータを省略
削除済みのユーザー、組織、グループが指定されてる場合はエラーになります。
指定した条件内に「order by」、「limit」および「offset」を含めるとエラーになります。
notifications[].title 文字列   通知内容を設定します。
指定できる文字列の長さは 100 文字以内です。
省略した場合は空文字になります。
notifications[].targets 配列 条件必須 通知先の対象を設定する配列です。
「notifications」パラメータを指定する場合、必須です。
notifications[].targets[].entity オブジェクト 条件必須 通知先の対象の種類を指定します。
「notifications[].targets」パラメータを指定する場合、必須です。
notifications[].targets[].entity.type 文字列 条件必須 条件通知の対象の種類を指定します。
「notifications[].targets[].entity」パラメータを指定する場合、必須です。
  • USER: ユーザー
  • GROUP: グループ
  • ORGANIZATION: 組織
  • FIELD_ENTITY: 作成者・更新者・作業者・ユーザー選択・組織選択・グループ選択フィールド
ゲストスペースの場合、組織を指定するとエラーになります。
notifications[].targets[].entity.code 文字列 条件必須 条件通知の対象のコードを指定します。
「notifications[].targets[].entity」パラメータを指定する場合、必須です。
notifications[].targets[].entity.type が FIELD_ENTITY の場合、以下のフィールドコードが指定可能です。
  • 作成者
  • 更新者
  • 作業者
  • ユーザー選択
  • 組織選択
  • グループ選択
ゲストユーザーの場合、ログイン名の前に「guest/」が付きます。
notifications[].targets[].includeSubs 真偽値または文字列   設定を下位組織に継承するかどうかの設定です。
「notifications[].targets[].entity.type」パラメータが
「ORGANIZATION」または「FIELD_ENTITY」で組織選択フィールドが指定されている場合のみ有効です。
  • 継承する場合: true
  • 継承しない(初期設定): false
省略した場合は false になります。
timezone 文字列   リマインド時刻のタイムゾーンの ID を指定します。
リマインダーの条件通知を一度も保存したことがない状態で値を指定しなかった場合は、
実行ユーザーのタイムゾーンが設定されます。
revision 数値または文字列   アプリの設定を変更する前のリビジョン番号を指定します。
指定したリビジョンが最新ではない場合、リクエストはエラーになります。
指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

PUT /k/v1/preview/app/notifications/reminder.json HTTP/1.1
    Host: example.cybozu.com:443
    X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
    Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

ボディ

レスポンス

パラメータ

パラメータ名 値の種類 説明
revision 文字列 アプリの設定を変更したあとのリビジョン番号です。

 

レスポンスの例

JavaScript サンプル

kintone REST APIリクエストを送信する API を使ったリクエスト

XMLHttpRequest を使ったリクエスト

記事に関するフィードバック

記事のコメント欄は記事に対するフィードバックをする場となっております。
右の記事フィードバックのためのガイドを参照してコメントしてください。
記事のリンク切れなど、気になる点がある場合も、こちらのフォームからフィードバックいただけますと幸いです。

サインインしてコメントを残してください。