1. ヘッダー

ヘッダー

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

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

REST API では標準の HTTP ヘッダーを使用して、要求と応答を装飾します。

広く使用されている要求ヘッダーは、次のとおりです。

名前説明
Accept目的のメディア形式を示します。現時点では、常に application/json とする必要があります。
If-None-Matchリソースの ETag ヘッダーが、送信されたいずれかの要求のヘッダー値と一致する場合は、この要求には 304 Not Modified 応答が返され、ローカルにキャッシュされたリソースが使用されます。
Content-Type要求にコンテンツが含まれている場合、このヘッダーは使用されるメディア形式を示します。現時点では、application/json のみがサポートされます。
X-Auth-Token要求の認証に使用されます。
X-Impersonateユーザーの偽装に使用されます。

返される最も一般的な応答ヘッダーは次のとおりです。

名前説明
Content-Type応答の本文で使用されるメディア形式です。現時点では JSON のみがサポートされているため、常に application/json が返されます。
ETagリソースによって返される、リソースのバージョンを表す文字列です。ネットワーク帯域幅の使用を最適化するため、If-None-Match ヘッダーとともに使用します。「キャッシュ」を参照してください。
Location新規リソースを作成すると、サーバーは 201 Created 応答を返し、このヘッダーを使用して、新規作成したリソースの URL を提供します。
X-Global-Identifier新規リソースを作成すると、サーバーは 201 Created 応答を返し、このヘッダー情報を使用して、新規作成したリソースのグローバル識別子を提供します。
注意

簡潔化のため、リソースの詳細に関する以降のページでは、これらのヘッダーについての説明を省略しています。

例

次の例は、HTTP 要求でヘッダーを使用する方法を示しています。

curl --request GET \
--url https://MyInstance/api/entities/48109 \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Auth-Token: XXXXXX' \
--header 'X-Impersonate: TheUserToImpersonate'
この記事を改善するための提案がある場合は、 お知らせください!