クレーム備考・経緯の作成

以下のいずれかのエンドポイントを使用して、既存のクレームまたはアクティビティから備考・経緯を作成する必要があります。

POST claim/v1/claims/{claimId}/notes
POST common/v1/activities/{activityId}/notes

備考・経緯に唯一必要なフィールドは本文であり、ここに備考・経緯のテキストが保存されます。必要に応じて、以下のフィールドを指定できます。


フィールド	データ型	説明	デフォルト
`confidential`	Boolean	備考・経緯が機密であるかどうか	false
`relatedTo`	インラインオブジェクト	クレームに添付される備考・経緯の場合、親クレームか、備考・経緯が関連する子オブジェクト（ClaimContact、エクスポージャー、またはサービス要求）のいずれか	親クレーム
`securityType`	Typekey（`NoteSecurityType`）	備考・経緯のセキュリティの種類	Null
`subject`	文字列	備考・経緯の件名	Null
`topic`	Typekey（`NoteTopicType`）	備考・経緯のトピックの種類	`general`

最小限の備考・経緯

以下は、クレーム cc:102 に関する最小限の備考・経緯の作成例です。

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." 
    }
  }
}

その他の詳細を含む備考・経緯

以下は、クレーム cc:102 に関する詳細な備考・経緯の作成例です。

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." ,
        "confidential": false,
        "securityType": {
          "code": "public"
        },
        "subject": "Pronunciation note",
        "topic": {
          "code": "general"
        }
    }
  }
}

子オブジェクトに添付される備考・経緯

デフォルトでは、すべての備考・経緯は親クレームにのみ添付されます。relatedTo フィールドを使用して、備考・経緯をクレームのいずれかの子オブジェクトに添付できます。このフィールドの構文は次のとおりです。

"relatedTo": {
  "id": "<childObjectId>",
  "type": "<childObjectType>"

例えば、以下は id cc:48 のエクスポージャーのクレーム cc:102 に関する備考・経緯の作成例です。

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The claimant's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'.",
        "relatedTo": {
          "id": "cc:48",
          "type": "Exposure"
        }
    }
  }
}

アクティビティに対する備考・経緯

以下は、アクティビティ xc:22 に関する備考・経緯の作成例です。

POST /common/v1/activities/xc:22/notes

{
  "data": {
    "attributes": {
        "body": "This activity was completed during a telephone call with the insured on 11/17." 
    }
  }
}