ページネーション

SearchAfter API (V1)

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

SearchAfter APIは、検索結果の複数ページを順番にフェッチするために使用されます。まず、ページの最後のアイテムに対応するlast_hit_data値を含む結果の最初のページに対する要求が行われます。この値は、すべての結果が取得されるまで、後続のページをフェッチするために使用されます。

大事な

すべての検索結果がメモリに保持されるわけではありません。ページ間で検索結果の一貫性を保つには、一意で簡単に並べ替えることができるクエリパラメーター (識別子など) を少なくとも1つ追加します。変更日を使用すると、同じ検索結果セット内のページ間を移動するときに新しいエンティティが変更された場合、一貫性のない結果が返される可能性があります。

このリソースは、次のURLから入手できます。

GET http://<HOSTNAME>/api/entities/searchafter/

SearchAfter APIには、次のクエリ文字列を含めることができます。

糸	形容
sort	ソートタイプで、2つの異なる入力があります。結果を並べ替えるアイテムの名前 (例: sort=CreatedOn&order=Asc)。ソートと順序の組み合わせ ( sort=CreatedOn+Asc,Importance+Descなど)
order	結果の順序。
searchAfter	最初の要求の後に要求を行うときの特定の結果セットについては、ここで先行する値last_hit_dataを指定します。
query	通常のクエリ。
take	ページごとにフェッチするアイテムの数。デフォルトは25で、最大値は100です。
members	取得するメンバー。
renditions	取得するレンディション。
culture	ユーザーカルチャ ( en-us.
sortCulture	カルチャが指定されていない場合は、デフォルトでインバリアントカルチャが使用されます。

例

次の例は、アセットのリストをフェッチするために行われた最初のリクエストを、作成日の昇順でソートして示しています。

/api/entities/searchafter?query=Definition.Name=="M.Asset"&sort=createdOn&order=Asc

結果には、212個のセットの最初の25個のアイテムが含まれます。ここでのlast_hit_dataの値は、25番目の項目に対応します。

  {
    "last_hit_data": [
      "1680149774978"
      ],
    "items": [],
    "total_items": 212,
    "returned_items": 25
  }

同じ条件に基づいて後続の要求に値last_hit_dataを追加することで、セット内の次の25個の項目 (26番目から始まる) をフェッチできます。

/api/entities/searchafter?query=Definition.Name=="M.Asset"&sort=createdOn&order=Asc&searchAfter=1678176769452

この記事を改善するための提案がある場合は、お知らせください!