ドキュメントに対するパッチ適用（PATCH）

以下を使用してドキュメントに対する PATCH を実行できます。

/common/v1/documents/{documentId}
/claim/v1/claims/{claimId}/documents/{documentId}

論理上は、PATCH 呼び出しによる変更はドキュメントのメタデータのみ、ドキュメントの内容のみ、またはその両方を対象にできます。

ドキュメントのメタデータに対する PATCH

内容だけを変更する必要がある場合でも、すべての PATCH /{documentId} 呼び出しに metadata キー／値のペアを含める必要があります。

メタデータを変更する場合は、metadata キーによって参照されている JSON 内で、変更するフィールドを指定します。
メタデータを変更する必要がない場合は、以下のように属性値のないペイロードを metadata キーに参照させます。

{
    "data": {
        "attributes": {
        }
    }
}

ドキュメントの内容に対する PATCH

PATCH /{documentId} 呼び出しは、content キー／値のペアを含める必要がありません。content を指定しない場合、PATCH によって更新されるのはドキュメントのメタデータだけとなります。

内容を PATCH すると上書きされますが、追記されません。content を指定する場合、新しい内容によって前の内容が全面的に置き換えられます。

ドキュメントに対する PATCH の例

以下は、ドキュメント xc:101 のメタデータだけに PATCH を実行する例です。この例では、ドキュメントのステータスが final に変更されています。

PATCH /common/v1/documents/xc:101

Metadata:
{
    "data": {
        "attributes": {
            "status": {
                "code": "final"
            }
        }
    }
}

(No contents included with the API call)

以下は、ドキュメント xc:101 の内容だけに PATCH を実行する例です。「Property Assessment Report.pdf」の内容は、ドキュメント xc:101 の現在の内容と異なる可能性が高いです。

PATCH /common/v1/documents/xc:101

Metadata:
{
    "data": {
        "attributes": {
            }
    }
}

Contents:
<contents of "Property Assessment Report.pdf" file>

以下は、ドキュメント xc:101 のメタデータと内容の両方に PATCH を実行する例です。

PATCH /common/v1/documents/xc:101

Metadata:
{
    "data": {
        "attributes": {
            "status": {
                "code": "final"
            }
        }
    }
}

Contents:
<contents of "Property Assessment Report.pdf" file>