前回は、cli-kintoneを使って、レコードのデータをエクスポートする方法を学びました。
今回も引き続き、顧客リストアプリを利用してレコードの追加／更新／削除の方法を紹介していきます。

データのエクスポートで発行したAPIトークンの「アクセス権」設定を変更します。
今回はレコードの追加／更新／削除のため、「レコード閲覧」「レコード追加」「レコード編集」「レコード削除」にチェックを入れてください。

まずは顧客リストアプリにレコードを追加してみましょう。

顧客リストアプリに追加するレコードのデータをCSVファイルで用意します。
CSVファイルを用意する際は、顧客リストアプリからエクスポートしたファイルを編集するのがおすすめです。
データのエクスポートを参考にcli-kintoneを使ってエクスポート、もしくは、 ファイルにデータを書き出す を参考にしてください。

1行目は列に対応するフィールドのフィールドコード、2行目以降が追加するデータとなります。
レコード追加の際、必須項目以外のフィールドのデータを入力する必要はありません。
「作成者」「作成日時」「更新者」「更新日時」は追加／更新ができないため、列を削除してください。
また、今回のデータには、後述の レコードの更新で更新する「部署名」フィールドを含めていません。

1
2
3
4

"company","name","post_code","tel","fax","address","rank","mail_address","note"
"朝日商事","品川 吉織","1660001","090-××××-××××","050-××××-××××","東京都杉並区××××","A","shinagawa_yoshiki@example.com","ご挨拶を実施"
"赤松機械","中田 助勝","1036028","080-××××-××××","040-××××-××××","東京都中央区××××","B","nakata_sukekatsu@example.com","新規のお客様"
"青木建設","友岡 春樹","3300041","070-××××-××××","030-××××-××××","埼玉県浦和市××××","C","tomooka_haruki@example.com","先月お問い合わせをいただいた"

上記のファイルを「add_customers.csv」とし、文字コードをShift-JISにして保存します。
今回は、cli-kintoneの実行ファイルを置いたディレクトリーにファイルを配置しています。

それではレコードを追加してみましょう。
レコードを追加する場合、record importを指定します。
ドメイン名とアプリID、APIトークンの他に--file-pathでCSVファイルのパスを指定します。
また、データのエクスポート時と同様に--encodingオプションでインポートするファイルの文字コードを指定できます。
今回はShift-JISのため、sjisを指定します。

1

cli-kintone.exe record import --app 299 --base-url https://sample.cybozu.com --api-token APIトークン --encoding sjis --file-path ./add_customers.csv

以下のようにレコードが追加されます。

レコードを更新する場合も、追加時と同様にrecord importを指定します。
また、--update-keyオプションで、更新のキーとなるフィールドのフィールドコードを指定します。
--update-keyオプションで指定できるフィールドは以下です。

• レコード番号
• 「値の重複を禁止にする」を有効にした次のフィールド
  • 文字列（1行）
  • 数値

--update-keyに指定したフィールドと、CSVファイル内の対応する列の値が一致するレコードは上書きされます。
一致しない場合は、新規にレコードが追加されます。

さっそく、 レコードの追加で追加したレコード情報を更新してみましょう。

idの列を含むデータをCSVファイルで用意します。
ファイルの用意は レコードの追加時の方法を参考にしてください。

では、「部署名」（フィールドコード：department）の値を更新するCSVファイルを用意してみましょう。
CSVファイルで入力を省略したフィールドは更新されないため、更新したいフィールドのみファイルに入力してください。

1
2
3
4

"id","department"
"6","経理部"
"5","開発部"
"4","営業部"

上記のファイルを「update_customers.csv」としてShift-JISで保存します。

今回は、レコード番号（フィールドコード：id）を更新のキーとするため、--update-keyにidを指定しましょう。

1

cli-kintone.exe record import --app 299 --base-url https://sample.cybozu.com --api-token APIトークン --encoding sjis --file-path ./update_customers.csv --update-key "id"

先ほど追加したレコードの「部署名」が更新されていることを確認しましょう。

CSVファイルに添付ファイルフィールドの列を含めてレコードを追加・更新する場合、--attachments-dirオプションが必須です。
詳細は 添付ファイルのダウンロードとアップロードを参照してください。

こちらは データのエクスポートの交通費申請アプリを使って確認しましょう。
わかりやすくするために、下表のように一部のフィールドコードを変更しています。
「明細」はテーブルフィールドで、「日付」「訪問先」「交通手段」「金額」はテーブル内のフィールドです。

また、顧客リストアプリと同じく、APIトークンの「アクセス権」設定で「レコード閲覧」「レコード追加」「レコード編集」「レコード削除」にチェックを入れてください。

交通費申請アプリに登録されているデータをエクスポートし、CSVファイルの中身を変更します。
今回は、更新対象をわかりやすくしたいため、--fieldsオプションに以下の項目を指定してフィールドを絞り込んでエクスポートします。

• レコード番号（フィールドコード：id）
• タイトル（フィールドコード：title）
• 明細（フィールドコード：detail）

1

cli-kintone.exe record export --app 300 --base-url https://sample.cybozu.com --api-token APIトークン --encoding sjis --fields "id,title,detail" > C:\Users\Desktop\update_table.csv

エクスポートしたCSVファイルの中身は以下になります。
前回の記事で説明したとおり、*の行から次の*の前の行までが1つのレコードのデータを表しています。
以下の場合、レコード番号がそれぞれ、1,2,3の3つのレコードがエクスポートされています。

1
2
3
4
5
6
7
8
9

*,"id","title","detail","date","place","transportation","price"
*,"1","7月分交通費","5039","2023-07-01","大阪支社訪問","新幹線（往復）","30000"
,"1","7月分交通費","5052","2023-07-04","通勤往復","電車（往復）","1500"
,"1","7月分交通費","5053","2023-07-06","通勤往復","電車（往復）","1500"
*,"2","6月分交通費","5043","2023-06-01","通勤往復","電車（往復）","1000"
,"2","6月分交通費","5050","2023-06-05","出張","飛行機（往復）","20000"
*,"3","7月分交通費","5047","2023-07-05","健康診断","バス（片道）","500"
,"3","7月分交通費","5048","2023-07-07","通勤往復","電車（往復）","2100"
,"3","7月分交通費","5049","2023-07-17","通勤往復","電車（往復）","2100"

今回は、次のようにCSVファイルを変更してみましょう。

• レコード番号が1のレコードについて、テーブルの最終行の金額（フィールドコード：price）を変更する。
• レコード番号が2のレコードについて、テーブルに行を追加する。
• テーブルのデータを含むレコードを新規に追加する。

CSVファイル内のid列に値が入っていない行は新規レコードとして追加されます。

1
2
3
4
5
6
7
8
9

*,"id","title","detail","date","place","transportation","price"
*,"1","7月分交通費","5039","2023-07-01","大阪支社訪問","新幹線（往復）","30000"
,"1","7月分交通費","5052","2023-07-04","通勤往復","電車（往復）","1500"
,"1","7月分交通費","5053","2023-07-06","通勤往復","電車（往復）","2000"
*,"2","6月分交通費","5043","2023-06-01","通勤往復","電車（往復）","1000"
,"2","6月分交通費","5050","2023-06-05","出張","飛行機（往復）","20000"
,"2","6月分交通費","","2023-06-10","出張","新幹線（往復）","30000"
*,"","8月分交通費","","2023-08-07","大阪支社訪問","新幹線（往復）","30000"
,"","8月分交通費","","2023-08-09","通勤往復","電車（往復）","2100"

上記のファイルを「update_table.csv」として保存します。

コマンドはレコードの更新時と同様に、--update-keyオプションを使用します。

1

cli-kintone.exe record import --app 300 --base-url https://sample.cybozu.com --api-token APIトークン --encoding sjis --file-path ./update_table.csv --update-key "id"

各レコードのサブテーブルの更新と、レコードの追加が行われます。

更新用CSVファイル

更新されたレコード

テーブルの最終行の金額が変更されたレコード

テーブルに新規の行が追加されたレコード

追加されたレコード

一部の行だけを更新する場合

テーブル内に更新しない行があっても、CSVファイルにはすべての行データを記載してください。
ファイルに記載のない行はテーブルから削除されます。

一部の列（フィールド）だけを更新する場合

テーブルの一部の列だけを更新する場合でも、すべてのフィールドのデータを記載してください。
ファイルに記載されていないテーブルのフィールドは、空で更新されます。

ただし、すべての行において更新しない列がある場合には、行IDを記載することで元のデータを保持できます。
行のIDは、テーブルフィールドのフィールドコードの値として確認できます。

たとえば、次のテーブルで「price」列のデータだけを更新したいとします。

この場合、次のCSVファイルを作成します。
「detail」が行のIDです。

1
2
3

*,"id","title","detail","price"
*,"1","7月分交通費","5039","40000"
,"1","7月分交通費","5053","2100"

最後にレコードを削除してみましょう。
レコードの削除は、削除対象を指定する方法と、すべてのレコードを一括で削除する方法の2パターンが存在します。

警告

削除したレコードは元に戻せません。

まずは、特定のレコードを削除してみましょう。
特定のレコードを削除する場合は、追加／更新時と同様に削除対象を記載したCSVファイルを用意します。

STEP 1. 削除するレコードのデータをCSVファイルで用意する

顧客リストアプリから削除するレコードのデータをCSVファイルで用意します。
列にはレコード番号フィールドのフィールドコードを指定します。

1
2
3

"id"
"1"
"2"

CSVファイルの2行目以降は、削除するレコードのレコード番号か、 アプリコード を設定している場合はアプリコードを含むレコード番号のどちらかを指定してください。
上記のファイルを「delete_customers.csv」として保存します。

STEP 2. レコードを削除する

削除する際は、record deleteを指定します。
record deleteを使ったレコードの削除は、APIトークン認証のみ対応しています。
追加／更新時と同様に、ドメイン名とアプリID、APIトークンを設定し、--file-pathでCSVファイルのパスを指定します。

1

cli-kintone.exe record delete --app 299 --base-url https://sample.cybozu.com --api-token APIトークン --file-path ./delete_customers.csv

コマンドを実行すると、削除を確認するメッセージが表示されます。
削除する場合は「y」を入力して、Enterキーを押します。キャンセルする場合は「n」を入力します。

--yesまたは-yオプションをつけてコマンドを実行すると、削除確認のメッセージが表示されずにレコードを削除できます。

1 2	# --yesオプションをつけると、確認メッセージが表示されずにレコードが削除されます cli-kintone.exe record delete --app 299 --base-url https://sample.cybozu.com --api-token APIトークン --file-path ./delete_customers.csv --yes

--file-pathオプションを省略すると、すべてのレコードを削除できます。

1

cli-kintone.exe record delete --app 299 --base-url https://sample.cybozu.com --api-token APIトークン

インポートや削除に失敗した場合、コマンドライン上のエラーメッセージを確認することでエラー原因を確認できますが、監査ログ上でもリクエスト結果を確認できます。
監査ログは一定期間の保存が可能なため、レコードの操作結果を後から確認できます。
詳細は、「 監査ログを閲覧する 」を参照ください。

監査ログの詳細では、次のことを確認できます。

• アクション：レコードの操作の内容（追加／更新／削除）
• 結果：アクションの結果
• 補足：操作対象のアプリやレコード番号、APIトークン

これらの内容を参照して、データの内容に誤りがないかなどを確認してみてください。

今回は、cli-kintoneを使って、レコードのデータを追加／更新／削除する方法を学びました。

次回は、 添付ファイルのダウンロードとアップロードの方法について学びましょう。

このTipsは、cli-kintone Ver 1.8.0と2023年8月版kintoneで動作を確認しています。