カテゴリー内の他の記事

レコードの条件通知の取得

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

URI

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

運用環境の設定を取得する場合

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

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

テスト環境の設定を取得する場合

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

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

HTTPメソッド

GET

必要なアクセス権

アプリ管理権限

リクエストパラメータ

パラメータ名 指定する値 必須 説明
app 数値又は文字列 必須 アプリのIDを指定します。
lang 文字列   フィールドの名前に「言語ごとの名称」を設定している場合に、取得する名称の言語を指定します。
  • 日本語の名称を取得する場合:ja
  • 英語の名称を取得する場合:en
  • 中国語の名称を取得する場合:zh
  • ログインユーザーの言語設定で取得する場合:user*
    *ログインユーザーの言語設定が「Webブラウザの設定にしたがう」の場合、
    Accept-Languageヘッダがあればその設定が反映され、
    Accept-Languageヘッダがなければcybozu.com共通管理の「ローカライズの設定」で設定された言語で取得されます。
  • デフォルトの名称を取得する場合:default
省略すると、デフォルトの名称が取得されます。

リクエストの例

送信するリクエストは、パラメータの送信方法によって異なります。パラメータ「app」と「lang」を指定したリクエストの例は、次のとおりです。

URLにパラメータを含める場合

GET /k/v1/app/notifications/perRecord.json?app=8&lang=ja HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

リクエストボディにパラメーターを含める場合
ヘッダ

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

ボディ

レスポンスパラメータ

パラメータ名 値の種類 説明
notifications 配列 条件通知の設定を表すオブジェクトの配列です。
設定の優先度が高いものから順に並びます。
notifications[].filterCond 文字列 レコードの条件です。クエリ形式で表されます。クエリ形式については、次のページを参照してください。
レコードの一括取得(クエリで条件を指定)
notifications[].title 文字列 通知内容です。
notifications[].targets 配列 通知先の対象を表すオブジェクトの配列です。
notifications[].targets[].entity オブジェクト 通知先の対象を表すオブジェクトです。
notifications[].targets[].entity.type 文字列 通知先の対象の種類です。
  • USER:ユーザー
  • GROUP:グループ
  • ORGANIZATION:組織
  • FIELD_ENTITY:作成者・更新者・ユーザー選択・組織選択・グループ選択フィールド
notifications[].targets[].entity.code 文字列

通知先の対象のコードです。
notifications[].targets[].entity.type の値に応じて、次の値が返却されます。

FIELD_ENTITY の場合:フィールドコード
それ以外の場合:通知先の対象

ゲストユーザーの場合、ログイン名の前に「guest/」が付きます。

notifications[].targets[].includeSubs 真偽値 設定を下位組織に継承するかどうかの設定です。
notifications[].targets[].entity.type の値が ORGANIZATION かFIELD_ENTITY で組織選択フィールドが指定されている場合以外、常にfalseが返却されます。
  • true:継承する
  • false:継承しない
revision 文字列 アプリの設定のリビジョン番号です。

レスポンスの例

JavaScriptサンプル

kintone REST API

XMLHttpRequest

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

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

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