レコードのコメント情報をCSVでダウンロードする方法

フォローする

(著者:近本 昌也)

はじめに

2016年5月のアップデートでレコードのコメントに関するAPIが3件追加されました。
これまで扱うことができなかったコメント情報の取得、投稿及び削除が可能となります。(詳細はリンク先をご確認ください。)

今回のサンプルでは レコードコメントの一括取得 のAPIを利用してレコードのコメント情報をCSV形式でダウンロードしてみました。
レコードのコメント機能が有効になっているお好きなアプリでお試しください。

完成イメージ

CSV出力用のボタンの設置と出力対象のコメント一覧

出力されたCSVファイル例

カスタマイズ

以下の3つのステップでJavaScriptカスタマイズを行い、レコードのコメント情報をCSVでダウンロードしてみましょう。

① コメントデータ取得
② CSV出力用にコメントデータのフォーマットを変更
③ ①、②を組み合わせて作成したCSVファイルをローカルにダウンロード

①コメントデータ取得

レコードコメントの一括取得 で一度に取得できるコメントは10件までとなります。
そのため、レコード内のコメントを全件取得するためには再帰処理を入れる必要があります。

参考:Promiseを利用したモダンなアプリの全レコード取得の書き方

②フォーマット変更

次に取得したコメントデータをCSV形式に変換します。

③ダウンロード

ヘッダにボタンを追加し、ファイルをダウンロードします。

応用 レコード一覧画面から全レコードのコメント情報を取得する ※2016/09/21追記

応用編として今度は
  • レコード一覧画面に「CSVでダウンロード」ボタンを配置しダウンロードを可能にする
  • CSVファイルのフィールドにレコード番号を追加する(どのレコードのコメントかを分かるようにする為)
という処理を行ってみました。

完成イメージ

CSV出力用のボタンの設置と出力対象のコメント一覧

CSV出力例

サンプルコード

関連Tips

最後に

今回はレコードコメントの一括取得を使ってコメント情報をエクスポートするカスタマイズ例を紹介させていただきました。
コメント情報がインポート、エクスポートできることでデータの移行やバックアップとしての利用シーンが増えそうです。

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

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

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

Avatar
uk.m

こちらのコードをゲストスペースのアプリに記述したのですが、うまく動作しませんでした。(単体のアプリでは動作しました)

40,67行のURL部分をゲストスペースのURLに書き換えれば良いかなと思っていたのですが、記述が間違っていたのか、それ以外にも他に変更を加える部分ってありますでしょうか。

あまりJSに明るくないのでご教授いただければと思います。よろしくお願いいたします。

Avatar
cybozu Development team

uk.m様

おはようございます。
cybozu developer network運営事務局です。

いただいた質問の回答は以下になります。

>40,67行のURL部分をゲストスペースのURLに書き換えれば良いかなと思っていたのですが、記述が間違っていたのか、それ以外にも他に変更を加える部分ってありますでしょうか。

uk.m様のおしゃる通り、今回はゲストスペースのURLを取得する必要がありますので、
40行目のkintone.api('/k/v1/records''GET', params)の部分をkintone.api(kintone.api.url('/k/v1/records', true), 'GET', params)のように第1引数を変更していただくと、
kintone REST APIの実行に必要なゲストスペース用のURIが返されるので、
うまく動作するかと思います。

こちら、再度お試しいただけますでしょうか。

よろしくお願いします。

ーーーーーーーーーーーーーーーー

※参照
kintone REST API リクエスト>URLを取得する
https://developer.cybozu.io/hc/ja/articles/202166310#step2

cybozu Development teamにより編集されました
ログインしてコメントを残してください。
Powered by Zendesk