アプリの条件通知の変更 – cybozu developer network

アプリの条件通知の設定を変更します。

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

URI

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

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

HTTPメソッド

PUT

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名	指定する値	必須	説明
app	数値又は文字列	必須	アプリのIDを指定します。
notifications	配列		条件通知の設定を表すオブジェクトの配列です。空配列を指定した場合は条件通知の設定を削除します。省略した場合は変更されません。条件通知の設定を追加、更新するときは、既存のすべての条件通知の設定を「notifications」に指定する必要があります。指定しなかった場合はその条件通知の設定が削除されます。
notifications[].entity	オブジェクト	条件必須	条件通知の設定の対象を表すオブジェクトです。「notifications」パラメータを指定する場合、必須です。
notifications[].entity.type	文字列	条件必須	条件通知の設定対象の種類です。「entity」パラメータを指定する場合、必須です。 USER：ユーザー GROUP：グループ ORGANIZATION：組織 FIELD_ENTITY：作成者・更新者・ユーザー選択・組織選択・グループ選択フィールド
notifications[].entity.code	文字列	条件必須	条件通知の設定対象のコードを指定します。「entity」パラメータを指定する場合、必須です。「notifications[].entity.type」パラメータに「FIELD_ENTITY」を指定する場合、フィールドコードを指定します。ゲストユーザーを指定する場合、ログイン名の前に「guest/」を付けます。
notifications[].includeSubs	真偽値又は文字列		設定を下位組織に継承するかどうかを指定します。継承する場合：true 継承しない場合（初期設定）：false notifications[].entity.type が ORGANIZATION か FIELD_ENTITY で組織選択フィールドが指定されている場合のみ有効。省略した場合はfalse。
notifications[].recordAdded	真偽値又は文字列		レコード追加で通知するかを指定します。レコード追加で通知する場合：true レコード追加で通知しない場合（初期設定）：false 省略した場合はfalse。
notifications[].recordEdited	真偽値又は文字列		レコード編集で通知するかを指定します。レコード編集で通知する場合：true レコード編集で通知しない場合（初期設定）：false 省略した場合はfalse。
notifications[].commentAdded	真偽値又は文字列		コメントの書き込みで通知するかどうかを指定します。コメントの書き込みで通知する場合：true コメントの書き込みで通知しない場合（初期設定）：false 省略した場合はfalse。
notifications[].statusChanged	真偽値又は文字列		ステータスの更新で通知するかどうかを指定します。ステータスの更新で通知する場合：true ステータスの更新で通知しない場合（初期設定）：false 省略した場合はfalse。
notifications[].fileImported	真偽値又は文字列		ファイル読み込みで通知するかどうかを指定します。ファイル読み込みで通知する場合：true ファイル読み込みで通知しない場合（初期設定）：false 省略した場合はfalse。
notifyToCommenter	真偽値又は文字列		コメントを書き込んだユーザーが、そのレコードにコメントが書き込まれたときに通知を受信するかどうかを指定します。コメントが書き込まれたときに通知を受信する場合：true コメントが書き込まれたときに通知を受信しない場合（初期設定）：false 省略した場合は変更されません。
revision	数値又は文字列		アプリの設定を変更する前のリビジョン番号を指定します。指定したリビジョンが最新ではない場合、リクエストはエラーになります。指定を省略、または「-1」を指定すると、リビジョンはチェックされません。

リクエストの例

ヘッダ

PUT /k/v1/preview/app/notifications/general.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 を使ったリクエスト

URI