POST の概要

POST はシステム API の操作であり、ClaimCenter でリソースまたは関連リソースのセットを作成します。また、POST 操作は、アクティビティのアサインなど、特定のビジネスプロセスの実行にも使用されます。

POST は、POST 操作とエンドポイント（POST /activities/{activityId}/notes など）、および要求ペイロードで構成されます。要求ペイロードには、作成するリソースについてのデータが含まれます。

POST への応答には、成功または失敗を示す HTTP コードが含まれます。また、応答ペイロードも含まれます。応答ペイロードの内容は、エンドポイントのスキーマによって決まります。

  • データの作成に使用されるエンドポイントでは、要求ペイロードからのデータが応答ペイロードに含まれます。また、ID やタイムスタンプなど、ClaimCenter が生成したデータも含まれる場合があります。
  • ビジネスアクションの実行に使用されるエンドポイントでは、応答ペイロードがビジネスアクションに関連するリソースとなります。アクション実行対象のリソースの場合もあります。例えば、アクティビティをアサインする際、アサインされるアクティビティが応答ペイロードに含まれます。また、ビジネスアクションで生成されるリソースの場合もあります。例えば、保険契約をキャンセルする際、応答ペイロードには JobResponse が含まれます。

開発者が呼び出し元アプリケーションのコンフィギュレーションを行い、情報をシステム API に POST する際、要求ペイロードで適切な構造を判断する必要があります。また、応答ペイロードからの情報の解析が必要な場合もあります。このトピックのこれ以降の部分で説明する内容は、リソースの要求ペイロードの構成方法と、開発者が要求ペイロードの形式について学ぶ方法です。

POST は、ビジネスアクションの実行にも使用されます。こうした種類の POST では、要求ペイロードが不要、任意、または必須である場合があります。例：

  • アクティビティを完了する POST で要求ペイロードは不要。
    • 要求ペイロードを任意で指定して、完了したアクティビティに備考・経緯を追加することは可能。
  • アクティビティをアサインする POST では要求ペイロードが必要。ペイロードでアクティビティのアサイン方法を指定。