HTTP ヘッダー

要求オブジェクトと応答オブジェクトは、アプリケーション間で情報を送信するために REST API によって使用されます。これらのオブジェクトには、HTTP ヘッダーが含まれています。HTTP ヘッダーは、要求または応答に関するメタデータを提供する要求または応答オブジェクトが含まれる名前と値のペアです。HTTP ヘッダーでは、以下のような情報を指定できます。

要求オブジェクトで使用される形式（JSON または XML のどちらかなど）
応答オブジェクトで使用される形式
セッションおよび接続情報
権限情報

Cloud API ヘッダーの概要

Cloud API では、Authorization や Content-Type などの標準の HTTP ヘッダーをサポートしています。

また、次の Guidewire 独自のヘッダーや標準ヘッダーの Guidewire 独自の値もサポートしています。Guidewire 独自のヘッダーはすべてオプションです。


ヘッダー	データ型	説明
`GW-Checksum`	文字列	これは、ロストアップデートを防ぐことができます。指定されている場合、呼び出しがデータベースコミットという結果になると、ヘッダーのチェックサムが ClaimCenter のチェックサム値と一致した場合にのみ、Cloud API がコミットを許可します。詳細については、ロストアップデートとチェックサムを参照してください。
`GW-DBTransaction-ID`	最大 128 文字の文字列	これは、重複要求を防ぐことができます。指定されている場合、この要求のデータベーストランザクション ID として使用されます。このヘッダー値が以前の要求で送信されていない場合にのみ、Cloud API がコミットを許可します。この値は ClaimCenter データベースに保存されます。また、すべてのクライアント、API、および Web サービスにわたってグローバルに一意である必要があります。詳細については、重複するデータベーストランザクションの回避を参照してください。
`GW-DoNotCommit`	Boolean	これは、エンドポイントのウォームアップに使用できます。通常、呼び出し元アプリケーションは、正規のビジネス要求の前に送信されるダミー POST にこれを指定します。この POST は、Java クラスや Gosu クラスの読み込みなど、エンドポイントの「ウォームアップ」アクティビティをトリガします。ただし、このヘッダーは、データのコミットを防ぎます。この要求により、そのエンドポイントに対する後続の要求のパフォーマンスを向上させることができます。詳細については、エンドポイントのウォームアップを参照してください。
`GW-IncludeSchemaProperty`	Boolean	JSON ペイロードの形式を変更できます。 true に設定されている場合、定義されたスキーマとともに JSON が返されると、`$GW-Schema` プロパティが応答のルート JSON オブジェクトに、そのオブジェクトの JSON スキーマ定義の完全修飾名とともに追加されます。デフォルトは false です。
`GW-Language`	文字列	応答の言語を設定します。詳細については、言語とロケールを参照してください。
`GW-Locale`	文字列	応答のロケールを設定します。詳細については、言語とロケールを参照してください。
`GW-UnknownPropertyHandling`	次の文字列値のいずれか： `log` `reject` `ignore`	不明なプロパティを含む要求ペイロードを処理する動作を指定します。デフォルトの動作は `reject` です。詳細については、不明な要素を含む呼び出しの処理を参照してください。
`GW-UnknownQueryParamHandling`	次の文字列値のいずれか： `log` `reject` `ignore`	不明なクエリパラメータを含む URL を処理する動作を指定します。デフォルトの動作は `reject` です。詳細については、不明な要素を含む呼び出しの処理を参照してください。
`GW-User-Context`	文字列	サービスでユーザーのためのサービス呼び出しやサービスのためのサービス呼び出しが生成された場合に、代表のユーザーに関する情報を提供します。詳細については、『Cloud API 認証ガイド』を参照してください。
`GW-ValidateResponseHandling`	Boolean	スキーマで宣言されている `maxLength` などの制約に対してサーバーが REST API 応答の追加検証を実行するように要求します。デフォルトでは無効ですが、カスタムエンドポイントのテストやデバッグといった一部のコンテキストでは有用です。詳細については、その他の制約に対する応答ペイロードの検証を参照してください。
`x-gwre-session`	文字列	関連する呼び出しがクラスタで実行されている ClaimCenter のインスタンスでルーティングされる方法を制御します（注意：このヘッダーは、Cloud API 専用ではないため、ヘッダー名の先頭に「GW」を使用するという規則には従いません）。詳細については、クラスター化環境での関連呼び出しのルーティングを参照してください。
`Prefer`	文字列	呼び出し元が待機時間を指定できるようにします（注意：これは標準の HTTP ヘッダーです。Cloud API では、このヘッダーの次の標準値をサポートします。`respond-async` と `respond-async, wait=T`。また、Guidewire 固有の値の 1つ、`respond-async, wait-ms=T` もサポートします）。詳細については、非同期呼び出しを参照してください。
`X-Correlation-ID`	文字列	最初の要求の受信から、要求を処理するために呼び出される後続のすべてのアプリーションを通して、顧客が要求を追跡できるようにします。 MDC やログに表示される（また、応答で返される）実際のトレーサビリティ ID は `TraceabilityIDPlugin` プラグインの実装に応じて異なります。デフォルトの実装ではこの値（指定されている場合）、または生成された UID が使用されます。ただし、別の実装では、常にユニーク ID が生成され、これらの受信値と生成された UID 間の関係性がログに記録される場合があります。このヘッダーは繰り返すことができますが、結果として生じる文字列は単なるカンマ区切り値になります（注意：このヘッダーは REST API フレームワーク以前から存在し、ヘッダー名の先頭に「GW」を使用するという規則より前に作成されました）。


ヘッダー	データ型	説明
`GW-Checksum`	文字列	これは、ロストアップデートを防ぐことができます。指定されている場合、呼び出しがデータベースコミットという結果になると、ヘッダーのチェックサムが ClaimCenter のチェックサム値と一致した場合にのみ、Cloud API がコミットを許可します。詳細については、ロストアップデートとチェックサムを参照してください。
`GW-DBTransaction-ID`	最大 128 文字の文字列	これは、重複要求を防ぐことができます。指定されている場合、この要求のデータベーストランザクション ID として使用されます。このヘッダー値が以前の要求で送信されていない場合にのみ、Cloud API がコミットを許可します。この値は ClaimCenter データベースに保存されます。また、すべてのクライアント、API、および Web サービスにわたってグローバルに一意である必要があります。詳細については、重複するデータベーストランザクションの回避を参照してください。
`GW-DoNotCommit`	Boolean	これは、エンドポイントのウォームアップに使用できます。通常、呼び出し元アプリケーションは、正規のビジネス要求の前に送信されるダミー POST にこれを指定します。この POST は、Java クラスや Gosu クラスの読み込みなど、エンドポイントの「ウォームアップ」アクティビティをトリガします。ただし、このヘッダーは、データのコミットを防ぎます。この要求により、そのエンドポイントに対する後続の要求のパフォーマンスを向上させることができます。詳細については、エンドポイントのウォームアップを参照してください。
`GW-IncludeSchemaProperty`	Boolean	JSON ペイロードの形式を変更できます。 true に設定されている場合、定義されたスキーマとともに JSON が返されると、`$GW-Schema` プロパティが応答のルート JSON オブジェクトに、そのオブジェクトの JSON スキーマ定義の完全修飾名とともに追加されます。デフォルトは false です。
`GW-Language`	文字列	応答の言語を設定します。詳細については、言語とロケールを参照してください。
`GW-Locale`	文字列	応答のロケールを設定します。詳細については、言語とロケールを参照してください。
`GW-UnknownPropertyHandling`	次の文字列値のいずれか： `log` `reject` `ignore`	不明なプロパティを含む要求ペイロードを処理する動作を指定します。デフォルトの動作は `reject` です。詳細については、不明な要素を含む呼び出しの処理を参照してください。
`GW-UnknownQueryParamHandling`	次の文字列値のいずれか： `log` `reject` `ignore`	不明なクエリパラメータを含む URL を処理する動作を指定します。デフォルトの動作は `reject` です。詳細については、不明な要素を含む呼び出しの処理を参照してください。
`GW-User-Context`	文字列	サービスでユーザーのためのサービス呼び出しやサービスのためのサービス呼び出しが生成された場合に、代表のユーザーに関する情報を提供します。詳細については、『Cloud API 認証ガイド』を参照してください。
`GW-ValidateResponseHandling`	Boolean	スキーマで宣言されている `maxLength` などの制約に対してサーバーが REST API 応答の追加検証を実行するように要求します。デフォルトでは無効ですが、カスタムエンドポイントのテストやデバッグといった一部のコンテキストでは有用です。詳細については、その他の制約に対する応答ペイロードの検証を参照してください。
`x-gwre-session`	文字列	関連する呼び出しがクラスタで実行されている ClaimCenter のインスタンスでルーティングされる方法を制御します（注意：このヘッダーは、Cloud API 専用ではないため、ヘッダー名の先頭に「GW」を使用するという規則には従いません）。詳細については、クラスター化環境での関連呼び出しのルーティングを参照してください。
`Prefer`	文字列	呼び出し元が待機時間を指定できるようにします（注意：これは標準の HTTP ヘッダーです。Cloud API では、このヘッダーの次の標準値をサポートします。`respond-async` と `respond-async, wait=T`。また、Guidewire 固有の値の 1つ、`respond-async, wait-ms=T` もサポートします）。詳細については、非同期呼び出しを参照してください。
`X-Correlation-ID`	文字列	最初の要求の受信から、要求を処理するために呼び出される後続のすべてのアプリーションを通して、顧客が要求を追跡できるようにします。 MDC やログに表示される（また、応答で返される）実際のトレーサビリティ ID は `TraceabilityIDPlugin` プラグインの実装に応じて異なります。デフォルトの実装ではこの値（指定されている場合）、または生成された UID が使用されます。ただし、別の実装では、常にユニーク ID が生成され、これらの受信値と生成された UID 間の関係性がログに記録される場合があります。このヘッダーは繰り返すことができますが、結果として生じる文字列は単なるカンマ区切り値になります（注意：このヘッダーは REST API フレームワーク以前から存在し、ヘッダー名の先頭に「GW」を使用するという規則より前に作成されました）。

Postman を使用した Cloud API ヘッダーを含む要求の送信

このタスクについて

Cloud API ヘッダーを Postman から実行される呼び出しに含めることができます。

手順

Postman で、［Launchpad］タブの右側の［+］をクリックして、新しい要求を開始します。
必要に応じて権限を指定します。
ヘッダーとヘッダー値を追加します。
- タブの先頭行（［パラメータ］で始まる行）で、［ヘッダー］をクリックします。
- 既存のキー／値のリストの下部までスクロールします。
- キー／値リストの下部にある空白行で、KEY 列にヘッダー名、VALUE 列にその値を入力します。
要求の処理と URL を入力します。
［送信］をクリックします。