カテゴリー内の他の記事

kintone Java Client のサンプルコード集

概要

Java から kintone REST API を短いコード量で実行できる、kintone Java Client がリリースされました。
この記事では、kintone Java Client を用いて kintone を操作するサンプルコードを紹介します。

kintone Java Client の導入方法や、基本的な使い方は、こちらの記事をご参照ください。

 

サンプルコード集

以降の例では、getKintoneClient() というKintoneClient を生成・取得するメソッドがあるものとします。
また、この記事の kintone Java Client は、v0.9.0 を利用しています。

レコード操作

レコードを操作するには、RecordClient を使います。

レコードの取得

アプリ ID が 3、レコード番号が 15 のレコードを取得する例です。

リクエストクラスを渡す方法

簡易メソッドを利用する方法

レコードの作成

数値フィールドに 30、文字列(1行)フィールドに "テキスト" という文字列を入れたレコードを作成する例です。

リクエストクラスを渡す方法

簡易メソッドを利用する方法

レコードの更新

ドロップダウンフィールドで "Apple" を選択するようにレコードを更新する例です。

この例では、kintone から更新したいレコードを取得して一部を修正した後、RecordClient#updateRecord() に渡してレコードを更新しています。

取得したレコードオブジェクトには、レコード作成者などのビルトインフィールド情報も含まれています。このビルドインフィールドを含んだ状態でレコード更新を行うと、更新に失敗します。

そのため、Record.newFrom(Record) を使って、ビルトインフィールドを含まないレコードに再生成しています。

レコードの一括取得

レコードを一括取得するには、RecordClient#getRecords() を利用します。

以下は、offset を利用してレコードを取得する例です。
offset を利用してレコード一括取得する場合、
第2引数に limit 、第2引数に offset を指定します。

※ 取得するレコード件数が 1 万件を超える場合、後述のカーソルを用いたレコードの全件取得、またはレコード ID を利用してレコードを一括取得する方法 を参考に、RecordClient#getRecords() にクエリを指定してレコードを取得してください。

カーソルを用いたレコードの全件取得

カーソル API を利用して、アプリのレコードを全件取得する例です。カーソル API を利用すると、高速にレコード全件を取得できます。

クエリでレコードを絞り込みたい場合、第3引数にクエリを指定します。

アプリ操作

レコードを操作するには、AppClient を使います。

アプリ情報の取得

アプリ ID が 30 のアプリ情報を取得するサンプルコードです。

複数のアプリ情報(例では、アプリ ID が 30 と 40)を取得できます。

アプリの設定の運用環境への反映

スペース操作

スペースを操作するには、AppClient を使います。

スペース情報の取得

SpaceClient#getSpace() でスペース情報を取得できます。

ファイル操作

ファイルを操作するには、FileClientを使います。

ファイルのアップロード

ファイルをアップロードする場合、ContentType の指定が必要です。
Java では java.nio.file.Files#probeContentType(Path) を使って自動判定できますが、Mac 環境下では動作しないことに注意してください。

アップロードに成功すると、fileKey が返却されます。
fileKey をレコードの添付ファイルに紐付けるには、レコードの登録やレコードの更新を使います(参照:アップロードしたファイルとレコードの関連付け)。

リクエストクラスを渡す方法

簡易メソッドを利用する方法

簡易メソッドを利用すると、ファイルパスを指定してファイルをアップロードできます。

ファイルのダウンロード

ファイルをダウンロードする場合、レコードを取得して添付ファイルフィールドからfileKey を取得します。この取得したfileKey をFileClient#downloadFile() に指定します。
このときのfileKeyは、ファイルのアップロードで返却される fileKey とは異なるので注意してください。

その他

複数アプリへのレコード一括処理

バルクリクエストを利用すると、複数のリクエストを同一トランザクションで実行できます。
例では、レコードを追加した後、レコードのステータス更新を行っています。

バルクリクエストで操作できる API はこちらをご参照ください。

このTipsは、2020年2月版 kintoneで確認したものになります。

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

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

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