REST API

ページング

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

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

ページングリソースは、現在の検索結果のページングに関連する情報を含むjsonリソースです。

名前	種類	形容
プロパティ	オブジェクト	プロパティと値を含むディクショナリオブジェクト。プロパティには、現在のページ番号 (1から始まるインデックス作成) と現在のページサイズが含まれます。
次に	Searchリンク	検索結果の次のページを表示するSearch Resourceへのハイパーリンク (次のページが存在する場合)。
先の	Searchリンク	検索結果の前のページを表示するSearch Resourceへのハイパーリンク (前のページが存在する場合)。
まずは	Searchリンク	検索結果の最初のページを表示するSearch Resourceへのハイパーリンク (まだ表示されていない場合)。
前の	Searchリンク	検索結果の最後のページを表示するSearch Resourceへのハイパーリンク (まだ表示されていない場合)。
page_sizes	配列	ユーザーが選択できるページごとの検索結果数のオプションを表す検索リンクの配列。
page_numbers	配列	ユーザーが番号でアクセスできる結果ページのオプションを表す検索リンクの配列。

例：

{
   {
    "properties": {
        "current_page_size": 10,
        "current_page_number": 5
    },
    "last": {
        "query":"currentQuery",
        "href":"http://<hostname>/api/search?q=currentQuery&skip=200&take=10"
    },
    "next": {
        "query":"currentQuery",
        "href":"http://<hostname>/api/search?q=currentQuery&skip=50&take=10"
    },
    "previous": {
        "query":"currentQuery",
        "href":"http://<hostname>/api/search?q=currentQuery&skip=30&take=10"
    },
    "first": {
        "query":"currentQuery",
        "href":"http://<hostname>/api/search?q=currentQuery&skip=0&take=10"
    },
    "page_sizes": [
        {
            "query":"currentQuery",
            "href":"http://<hostname>/api/search?q=currentQuery&skip=0&take=5",
            "title": "5"
        },
        {
            "query":"currentQuery",
            "href":"http://<hostname>/api/search?q=currentQuery&skip=0&take=10",
            "title": "10"
        },
        {
            "query":"currentQuery",
            "href":"http://<hostname>/api/search?q=currentQuery&skip=0&take=50",
            "title": "50"
        }
    ],
    "page_numbers": [
        {
            "href":"http://<hostname>/api/search?q=currentQuery&skip=30&take=10",
            "title": "4"
        },
        {
            "href":"http://<hostname>/api/search?q=currentQuery&skip=40&take=10",
            "title": "5"
        },
        {
            "href":"http://<hostname>/api/search?q=currentQuery&skip=50&take=10",
            "title": "6"
        }
    ]
}

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