はじめに
kintoneのJavaScriptカスタマイズを利用することで、フォーム部品やアクション等の標準機能とは別に、レコード処理等の機能を実装することができます。本記事は、JavaScriptの経験はあっても、kintoneでは初めて使われる方に読んで頂きたい内容となります。
本記事の対象読者
- kintone、JavaScriptについて基本的な知識をお持ちの方
- 初めてkintoneのJavaScriptカスタマイズを 利用される方
- kintone標準機能から一歩踏み出してみたい方
kintoneカスタマイズで取り扱うAPI
JavaScriptで画面表示やレコード関連の操作を行うため、kintoneには以下のようなAPIが用意されています。
| APIの種類 | 機能 |
|---|---|
| kintone REST API |
kintoneのデータ連携のためのAPIです。レコードの取得／登録／更新／削除等の機能があります。今回は触れませんが、ファイルのアップロード/ダウンロード、アプリやフォームの設定情報のAPIも含まれます。 |
| kintone JavaScript API |
kintoneのデータ連携のためのAPIです。レコードの取得／登録／更新／削除等の機能があります。今回は触れませんが、ファイルのアップロード/ダウンロード、アプリやフォームの設定情報のAPIも含まれます。 |
本記事では、kintone REST API（以下、REST API）をメインとしてご紹介していきます。
kintone REST APIを使用する基本的なサンプルとして、指定したクエリ条件にマッチするレコードを取得するコードは下記のようなイメージとなります。
// アプリ名を元に処理対象アプリのアプリIDを取得
var app = kintone.app.getRelatedRecordsTargetAppId('アプリ名');
// クエリ条件
query = '営業所番号="' + ShopNo + '"';
// 取得フィールド
fields = ["レコード番号", "営業所番号","営業所名"];
// リクエストボディ
var body = {
'app': app ,
'query': query ,
'fields': fields
};
// クエリ条件にマッチするレコードを取得
kintone.api(kintone.api.url('/k/v1/records', true), 'GET', body, function(resp) {
// 取得レコードを表示
console.log(resp);
});
実際にはレコード保存（保存ボタン押下）等のイベントのタイミングでkintone REST API更新処理等を行う形となります。イベント処理の記述方法やkintone REST APIに含まれる機能等については、随時更新されるため、以下のリンク先にて最新の情報を確認すると良いでしょう。
- イベント処理の記述方法
- kintone REST API
おわりに
今回は、kintoneカスタマイズに使用するAPIにどのようなものがあるか、kintone REST APIの利用イメージや情報入手先について簡単にご提示しました。次回は、kintone REST APIを利用したデータ更新の概念について説明いたします。