GetItemHistoriesAPIの条件

@jeanepaul @iwasaki.hexabase @hx-support

GetItemHistories

こちらのAPI実行時に検索条件を付与することはできますでしょうか?

< 改善を要望する理由 >

チャット機能において、アイテムの更新履歴を利用するサンプルをご提示いただきましたが、
履歴の件数が100件の時点でGetItemHistories APIのレスポンスに2秒かかりました。
また、検索条件が指定できないため、やり取りが多くなると、パフォーマンスに問題があります。

段階的に取得できるように時間の範囲指定と、取得件数の指定を行うように改修可能でしょうか?

もしも、現行の仕様で上記の問題を回避できる方法などがあれば教えていただきたいです。

@iwasaki.hexabase
先行で変更可否の調査いただけるということでしたので、よろしくお願いいたします。

@k-otani まずは、調査し明日中にはご回答差し上げます。

1 Like

@k-otani
ItemHistoryにつきまして、まず、表示件数を制限させるパラメーターがございます。
(こちらがドキュメントに記載されておりませんでした。大変失礼いたしました。)

例えば、最初から20件を取得する場合、

.../histories?to_item_index=19

と指定することで件数を制限できます。

ご要望いただきました、更新日付で結果を絞り込むことは現在APIでは実装されておりませんが、
条件として追加することは比較的容易に可能であることも確認できました。
プロジェクトでのご利用のご予定がございましたら、ご要望ください。

また、ドキュメントについて更新いたしましたので、現仕様については以下をご参照ください。

@iwasaki.hexabase
本件、時間をFrom、Toで検索できるように改修お願いいたします。

@k-otani すみません、一つ確認です。こちらSDKか historiesの取得が遅いの話いですか?

そうであれば、SDKで入れておきます。でなければ、岩崎さんの言う通りでパラメーターの追加をお願いできますか?

@jeanepaul @iwasaki.hexabase
GetItemHistories APIの修正のお願いです。

GetItemHistories APIのパラメータに、From、Toで更新時間の検索できるよう修正をお願いしています。

GetItemHistories

1 Like

@k-otani 更新時刻による絞り込みについて承知いたしました。リリース目途については、追って連絡いたします。(来週前半を目標としております。)

@jeanepaul はい、SDKの修正もお願いします!

@iwasaki.hexabase
ちなみにですが、以下のURLパラメータで取得数を絞ってみましたが、パラメータ付与して取得数を少なくしても、100件全部取得する場合と、応答にかかる時間が同じでした。
.../histories?to_item_index=1

From、Toパラメータを設定できるようにした場合にパフォーマンスは向上できますでしょうか?
パフォーマンスがネックとなるため、考慮をお願いいたします。

@k-otani 状況のご連絡ありがとうございます。
承知いたしました。
改善策として少し思い当る点がありますので、合わせて確認の上、回答いたします。

1 Like

@iwasaki.hexabase
度々申し訳ございませんが、追加で検索の要望です。
コメントした際に 「〇〇さんの編集」と「〇〇さんのコメント」の2パターンがあるようですが、
これらも検索条件に加えることはできますでしょうか?
コメントだけを取得する とか 編集だけ取得するなど
image

@k-otani はい、可能かと存じます。合わせて対応を検討いたします!

こちらのリリースにて、コメント履歴、または、アクション実行履歴をフィルタする条件を追加させていただきました。
どうぞよろしくお願いいたします。