PATCH の概要

PATCH は、ClaimCenter の既存のリソースを変更する REST API メソッドです。

PATCH は、PATCH メソッドとエンドポイント(PATCH /activities/{activityId} など)、および要求ペイロードで構成されます。この要求ペイロードには、指定されたリソースで変更されるデータが含まれます。

PATCH への応答には、成功または失敗を示す HTTP コードが含まれます。また、応答ペイロードも含まれます。PATCH のデフォルトの応答は、事前設定されたフィールドとリソースのセットで構成されます。これには、PATCH で変更されたデータが含まれる場合も、含まれない場合もあります。

開発者がコンシューマアプリケーションのコンフィギュレーションを行い、クラウド API に情報の PATCH を行う際は、要求ペイロードの適切な構造を判断する必要があります。また、応答ペイロードからの情報を解析する必要がある場合もあります。

PUT 操作

REST API アーキテクチャには、既存のリソースを変更する 2 つの操作である、PATCH と PUT があります。PATCH は、既存のリソースの一部を変更するために使用します(その他の部分は変更されないままとなります)。PUT は、既存のリソースのすべての内容を新しいデータに置き換えるために使用します。Cloud API では、PATCH 操作をサポートしていますが、PUT 操作はサポートしていません。これは、InsuranceSuite オブジェクトを変更する操作はほぼすべて、オブジェクトの一部のみを変更し、残りの部分はそのまま残すためです。この動作は PATCH には当てはまりますが、PUT には当てはまりません。