Patchen von Dokumenten

Dokumente können Sie folgendermaßen patchen:

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

Logisch betrachtet, kann ein PATCH-Aufruf nur die Metadaten eines Dokuments, nur den Inhalt eines Dokuments oder beides ändern.

Patchen von Dokumentmetadaten

Jeder PATCH /{documentId}-Aufruf muss ein Schlüssel-Wert-Paar aus metadata enthalten, auch wenn Sie nur den Inhalt ändern möchten.

  • Wenn Sie die Metadaten ändern möchten, geben Sie die zu ändernden Felder in JSON an, auf das durch den metadata-Schlüssel verwiesen wird.
  • Wenn Sie die Metadaten nicht ändern möchten, muss der metadata-Schlüssel wie unten gezeigt auf Nutzdaten ohne Attributwerte verweisen:
{
    "data": {
        "attributes": {
        }
    }
}
Java

Patchen von Dokumentinhalten

Ein PATCH /{documentId}-Aufruf ist nicht erforderlich, um ein Schlüssel-Wert-Paar für content einzuschließen. Wenn kein content angegeben wird, aktualisiert PATCH nur die Dokumentmetadaten.

Inhalt-Patches sind destruktiv, nicht additiv. Wenn Sie content angeben, ersetzt der neue Inhalt den vorherigen Inhalt vollständig.

Beispiele für das Patchen von Dokumenten

Das folgende Beispiel zeigt, wie nur die Metadaten für das Dokument xc:101 gepatcht werden. In diesem Beispiel wird der Dokumentstatus in final geändert.

PATCH /common/v1/documents/xc:101

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

(No contents included with the API call)
Java

Das folgende Beispiel zeigt, wie nur der Inhalt des Dokuments xc:101 gepatcht wird. Vermutlich unterscheiden sich der Inhalt von „Property Assessment Report.pdf“ vom aktuellen Inhalt des Dokuments xc:101.

PATCH /common/v1/documents/xc:101

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

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

Das folgende Beispiel zeigt, wie sowohl die Metadaten als auch der Inhalt für das Dokument xc:101 gepatcht werden.

PATCH /common/v1/documents/xc:101

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

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