HTTPヘッダー
REST APIでは、次のHTTPヘッダーがサポートされています。
| ヘッダー | 説明 |
|---|---|
| Accept |
Content-レスポンスが受け入れることができるコンテンツ・タイプ。 |
| Accept-Encoding |
レスポンスで受け入れられるエンコーディング。 |
| Cache-Control |
REST APIは、フレームワーク・ペイロードをキャッシュまたは格納するときに中間プロキシを使用しないように、HTTPレスポンスごとにこのヘッダーを構成します。 次のいずれかの値を含めることができます:
|
| Content-Type |
リクエストの本文のメディア・タイプ。 REST APIでは、POSTまたはPUTリクエストごとにこのヘッダーが必要です。 たとえば:
|
| ETag |
リソースが変更されると、リソースによってETagが作成されます。 クライアントは、ETagを使用してキャッシュを制御できます。 |
| If-Match |
条件付きリクエストを実行できます。 |
| If-None-Match |
条件付きリクエストを実行できます。 |
| 事業所 |
新規リソースのURLを識別するレスポンス内のロケーション。 REST APIでは、新規リソースの作成時にこのヘッダーが追加されます。 |
| X-HTTP-Method-Override |
HTTPメソッドの名前が含まれます。 この値を使用して、HTTPメソッドを定義できます。 REST APIでは、このヘッダーはPOSTメソッドでのみ考慮されます。 これは、HTTP仕様の一部ではない変更済ヘッダーです。 |
| X-ID-TENANT-NAME |
REST APIが認証に使用するアイデンティティ・ドメイン名。 たとえば:
|
| X-Requested-By |
antiCSRFを有効にした場合、REST APIでは、次のメソッドを除くすべてのリクエストに対してこのヘッダーが必要です:
REST APIでこのヘッダーが見つからない場合は、レスポンス400、不正なリクエストが返されます。 |