カテゴリー内の他の記事

レコード一括取得の JavaScript コーディング例

Index

はじめに

レコードを一括取得する方法には、大きく3つの選択肢があり、利用ケースに応じて適切な方法を選択する必要があります。
それぞれの方法の特徴や使い分けについては、こちらの記事で紹介しているので、ご参照ください。

この記事では、各方法の JavaScript のコーディング例を紹介します。

共通事項

  • 各方法の getRecords 関数を呼び出すサンプルコードでは、アプリストアの「案件管理」アプリを利用しています。
  • フィールドコードは、フィールド名と同じに設定しています。

方法 1 レコード ID を利用する方法

レコード一括取得 API で、レコード ID(レコード番号)の昇順でソートを行い、ID 順にレコードを取得する方法です。

サンプルコード

レコードを取得する関数

getRecords 関数の呼び出し例

  • 絞り込み条件・ソート条件・取得するフィールドを指定した場合
    ※ レコード ID を利用してレコードを取得する場合は、sortConds に「'$id asc'」を追加してください。
  • 指定しない場合
    ※ アプリ ID を指定しない場合は、表示中のアプリのレコードを取得します。

方法 2 カーソル API を利用する方法

カーソル API を使ってレコードを取得する方法です。

サンプルコード

レコードを取得する関数

getRecords 関数の呼び出し例

  • 絞り込み条件・ソート条件・取得するフィールドを指定した場合
  • 指定しない場合
    ※ アプリ ID を指定しない場合は、表示中のアプリのレコードを取得します。

方法 3 offset を利用する方法

レコード一括取得 API を使い、リクエストパラメータの offset を指定して順次レコードを取得する方法です。

サンプルコード

レコードを取得する関数

getRecords 関数の呼び出し例

  • 絞り込み条件・ソート条件・取得するフィールドを指定する場合
  • 指定しない場合
    ※ アプリ ID を指定しない場合は、表示中のアプリのレコードを取得します。

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

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

Avatar
赤座 久樹

@kintone/rest-api-client の getAllRecordsを使えば
カーソルを意識しなくてもスムーズにリクエスト投げられるので、今後はこっちが王道だと思います。

https://github.com/kintone/js-sdk/blob/master/packages/rest-api-client/docs/record.md#getAllRecords

7月に向けて、このツールの啓蒙に力入れて頂くのが一番良いのではないでしょうか。
まだあんまり知られてなくて、大変勿体無いです。

赤座 久樹により編集されました
サインインしてコメントを残してください。