オブジェクトへのリンク

リンク拡張の使用

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

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

収集リソースを要求するときに、そのリソースだけでなく、そのリンクされた1つ以上のリソースもサーバーに返すようにしたい場合があります。リンク拡張を使用すると、複数の個別の要求を発行する代わりに、サーバーへの1つの要求で関連リソースを取得できます。この手法を使用すると、サーバーへのラウンドトリップ通信要求の数を減らし、アプリケーションのパフォーマンスを向上させることができます。

リソースの拡大

コレクションを取得し、その項目を展開するには、expandクエリパラメーターに値trueを指定できます。これにより、複数の後続要求 (コレクションに1つ、コレクションごとに1つ) を発行する必要がなくなります。

expandクエリパラメーターを使用する場合:

curl -X GET '<baseURL>/v2/someCollection?expand=true'

JSON応答の展開されたitems配列:

{
  "href": "<baseURL>/v2/someCollection?expand=true",
  "offset": 0,
  "limit": 10,
  "items" : [
    {
      "href": "<baseURL>/v2/someCollection/37e60a14-9198-4b38-8bc3-f3924e2b6fe4?expand=true",
      "name" : "My sample name"
    },
    {
      "href": "<baseURL>/v2/someCollection/D1548691-47DF-41B6-A7B7-77516A76D62C",
      "name" : "My other sample name"
    }
  ]
}

JSON応答では、itemsはリンクではなくなりました。代わりに、インラインで拡張され、応答本文に含まれています。

サブリソースの拡張

1つのサブリソースまたはサブリソースのリストのみを展開したい場合があります。これを行うには、サブリソースの名前をexpandクエリパラメーターの値として指定します。

複数のサブリソースを展開する場合は、サブリソースの名前をカンマ区切りリストとして含めます。

サブリソースの拡張:

curl -X GET '<baseURL>/v2/someCollection/37e60a14-9198-4b38-8bc3-f3924e2b6fe4?expand=someSubResource'

JSON応答の展開されたサブリソース:

{
    "href": "<baseURL>/v2/someCollection/37e60a14-9198-4b38-8bc3-f3924e2b6fe4?expand=someSubResource",
    "name" : "My sample name",
    "someSubResource": {
      "href": "<baseURL>/v2/someCollection/37e60a14-9198-4b38-8bc3-f3924e2b6fe4/someSubResource",
      "name" "My sample some sub resource name"
    },
    "someSubCollections": {
      "href": "<baseURL>/v2/someCollection/37e60a14-9198-4b38-8bc3-f3924e2b6fe4/someSubCollections"
    }
}

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