カテゴリー内の他の記事

レコードの条件通知の変更

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

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

URI

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

ゲストスペースのアプリの場合:https://(サブドメイン名).cybozu.com/k/guest/(スペースのID)/v1/preview/app/notifications/perRecord.json

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリのIDを指定します。
notifications 配列 必須

条件通知の設定を表すオブジェクトの配列です。優先度が高い設定から順に並べます。
空配列を指定した場合は条件通知の設定を削除します。

notifications[].filterCond   条件必須

レコードの条件をクエリ形式で指定します。「notifications」パラメータを指定する場合、必須です。
クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)

省略した場合は「すべてのレコード」が対象となります。

notifications[].title    

通知内容を指定します。

省略した場合は空文字となります。

notifications[].targets   条件必須

通知先の対象を指定します。「notifications」パラメータを指定する場合、必須です。
空配列を指定した場合は通知先なしの設定で更新します。

notifications[].targets[].entity オブジェクト 条件必須 条件通知の設定の対象を表すオブジェクトです。「targets」パラメータを指定する場合、必須です。
notifications[].targets[].entity.type 文字列 条件必須 条件通知の設定対象の種類です。「entity」パラメータを指定する場合、必須です。
  • USER:ユーザー
  • GROUP:グループ
  • ORGANIZATION:組織
  • FIELD_ENTITY:作成者・更新者・ユーザー選択・組織選択・グループ選択フィールド
notifications[].targets[].entity.code 文字列 条件必須 条件通知の設定対象のコードを指定します。「entity」パラメータを指定する場合、必須です。
「notifications[].entity.type」パラメータに「FIELD_ENTITY」を指定する場合、フィールドコードを指定します。
ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
notifications[].targets[].includeSubs 真偽値又は文字列   設定を下位組織に継承するかどうかを指定します。
  • 継承する場合:true
  • 継承しない場合(初期設定):false

notifications[].targets[].entity.type が ORGANIZATION か FIELD_ENTITY  で組織選択フィールドが指定されている場合のみ有効。
省略した場合はfalse。

revision 数値又は文字列   アプリの設定を変更する前のリビジョン番号を指定します。
指定したリビジョンが最新ではない場合、リクエストはエラーになります。

指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

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

ボディ

レスポンスパラメータ

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

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

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

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

Avatar
金田 晃

ボディの例にappが抜けているようです。

Avatar
cybozu Development team

金田様

ご指摘をありがとうございます。ボディの例を修正いたしました。

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