レコードの条件通知の設定を変更します。
この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」に指定する必要があります。 |
| notifications[].filterCond | 条件必須 |
レコードの条件をクエリ形式で指定します。「notifications」パラメータを指定する場合、必須です。 省略した場合は「すべてのレコード」が対象となります。 |
|
| notifications[].title |
通知内容を指定します。 省略した場合は空文字となります。 |
||
| notifications[].targets | 条件必須 |
通知先の対象を指定します。「notifications」パラメータを指定する場合、必須です。 |
|
| notifications[].targets[].entity | オブジェクト | 条件必須 | 条件通知の設定の対象を表すオブジェクトです。「targets」パラメータを指定する場合、必須です。 |
| notifications[].targets[].entity.type | 文字列 | 条件必須 | 条件通知の設定対象の種類です。「entity」パラメータを指定する場合、必須です。
|
| notifications[].targets[].entity.code | 文字列 | 条件必須 | 条件通知の設定対象のコードを指定します。「entity」パラメータを指定する場合、必須です。 「notifications[].entity.type」パラメータに「FIELD_ENTITY」を指定する場合、フィールドコードを指定します。 ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。 |
| notifications[].targets[].includeSubs | 真偽値又は文字列 | 設定を下位組織に継承するかどうかを指定します。
notifications[].targets[].entity.type が ORGANIZATION か FIELD_ENTITY で組織選択フィールドが指定されている場合のみ有効。 |
|
| 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リクエストを送信する API を使ったリクエスト
XMLHttpRequest を使ったリクエスト
ボディの例にappが抜けているようです。
金田様
ご指摘をありがとうございます。ボディの例を修正いたしました。