ルックアップフィールドで「フィールドの値を変更したときのイベント」が発生する

目次

caution
警告

このページで説明しているAPIは、開発を検討中のAPIです。

アップデートオプション内の「検討中の新機能」から動作をお試しいただけます。
設定方法は、 新機能の有効/無効の切り替え手順 (External link) を参照してください。

APIに関するフィードバックを、ユースケースとともに、 kintoneの改善に協力する (External link) フォームへぜひご登録ください。

フィードバックの例
  • 「APIラボで提供されているAPIを早く本番環境で利用したい」
  • 「こういう用途で使うために、このようなAPIを提供してほしい」

ルックアップフィールドで「フィールドの値を変更したときのイベント」が発生する

ルックアップフィールドで「フィールドの値を変更したときのイベント」が発生します。
また、kintone JavaScript APIやイベントで取得できるレコード情報のルックアップフィールドの値にルックアップの状態を表す値を追加します。

利用するには検討中の新機能の「ルックアップフィールドで『フィールドの値を変更したときのイベント』が発生する機能」を有効にしてください。

対象イベント

レコード追加/編集画面で、ルックアップフィールドの値を変更した時に次のイベントが発生します。

イベントの発生タイミング

次のいずれかのタイミングで、イベントが発生します。ただし、ルックアップフィールドに入力している検索用のキーワードを変更した場合か、ルックアップで選択した参照先のレコードが変更されている場合だけ発生します。

  • ルックアップフィールドで【取得】ボタンをクリックして参照するレコードを確定したとき(一致するレコードが1つで自動取得された場合と、複数の候補からダイアログで選択した場合の両方を含みます)
  • ルックアップフィールドをクリアしたとき
  • ルックアップフィールドからフォーカスが外れたとき

ルックアップフィールドの値を変更したときのイベントは、コピー先フィールドの値を変更したときのイベントより先に発生します。

ルックアップの状態を表す値の追加

kintone JavaScript APIやイベントオブジェクトのプロパティで取得できるレコード情報に含まれるルックアップフィールドの値に、次の情報を追加します。

プロパティ 説明
confirmed 真偽値 参照先のレコードが確定しているかどうか
参照先のレコードが確定しているとき、および【クリア】ボタンを押して参照するレコードをクリアしたときにtrueになります。
recordId 文字列 参照先のレコードのレコードID
ルックアップフィールドに値が入力されていないとき、および入力済みでも参照先のレコードが未確定のときは「null」になります。

valueconfirmedrecordIdは、その時点のルックアップフィールドの状態に応じた組み合わせになります。
組み合わせの例は次のとおりです。

ルックアップフィールドの状態 value confirmed recordId
「kintone」を入力し、参照先のレコードを取得済みのとき "kintone" true "(レコードID)"
「kintone」を入力したが、まだ参照先のレコードを取得していないとき "kintone" false null
未入力のとき(初期状態、またはクリアした後) "" true null

参照先のレコードを取得済みのときのオブジェクトの例は次のとおりです。

1
2
3
4
5
6
"フィールドコード": {
  "type": "SINGLE_LINE_TEXT",
  "value": "kintone",
  "confirmed": true,
  "recordId": "10"
}