1. HTTP の実装

HTTP の実装

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

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

検索 API は Sitecore Content Hub のベース API に基づいています。ここでは、この 2 つの API の違いについて説明します。

メソッド

検索 API では標準 HTTP メソッドのサブセット、つまり GET、HEAD、POST メソッドを使用してタスクを実行します。これは読み取り専用の API と考えることができ、ベース API を介して実行した場合、リソースを大量に消費する可能性のある検索およびフィルタリング操作を実行するためのインターフェイスとして使用されます。

名前タイプ
GETコンテンツを含む、リソースの現在の状態を取得します。
HEADコンテンツを含めずに、リソースの現在の状態を取得します。
POSTGET と同じ働きを持ちますが、パラメーターは url 引数ではなくリソースに渡されます。

ヘッダー

検索 API ではベース API と同じ要求ヘッダーが使用されますが、すべての応答ヘッダーが使用されるわけではありません。つまり、リソースの作成がサポートされないため、検索 API では "Location" ヘッダーが使用されません。

応答コード

検索 API の応答コード セットは、ベース API の応答コードのサブセットとなります。

  • "200 OK"
  • "304 Not Modified"
  • "400 Bad Request"
  • "403 Forbidden"
  • "404 Not Found"
  • "500 Server Error"

リンク

検索 API は、すべての場所がリンクを介してアクセスおよび検出可能という点で、ベース API の原則に従います。

ページング

ページングの動作はベース API の動作と似ていますが、検索 API では、ユーザーはページ サイズ オプションのリストから必要なページ サイズを選択できるという違いがあります。

並べ替え

検索 API はベース API とは異なり、結果として返されるアセット タイプにも応じて、検索結果を事前定義されたいくつかのパラメーターで並べ替えることができます。

カルチャ

検索 API は多文化に対応します。

キャッシュ

その動作はベース API の動作と一致します (ハイパーメディア API ドキュメントの「キャッシュ」を参照)。

認証

認証はベース API を介して行われます。

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