REST API

ヘッダー

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

このページの翻訳は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で応答し、新しく作成されたリソースのGLOBAL IDENTIFIERを提供するためにこのヘッダー情報を含めます。

メモ

簡潔にするために、これらのヘッダーについては、リソースの特定の詳細について説明する際に、ドキュメントで再度説明しません。

例

次の例は、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: TheUsernameToImpersonate'

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