Buchen von Dokumenten

Dokumente können Sie folgendermaßen buchen:

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

FormData-Objekte

Für die meisten Cloud-API-Ressourcen wird das Anforderungsobjekt als Text mit einer einzelnen Zeichenfolge von JSON-Text konstruiert. Dieses Format ist jedoch für Dokumente nicht ausreichend robust. Beim Arbeiten mit Dokumenten muss die aufrufende Anwendung zwei Datensätze senden: die Metadaten des Dokuments und den Inhalt des Dokuments. Dies erfolgt mithilfe von FormData-Objekten.

FormData ist eine dem Industriestandard entsprechende Schnittstelle, die ein Objekt als einen Satz von Schlüssel-Wert-Paaren konstruiert. Wenn eine aufrufende Anwendung einen POST /documents-Aufruf erstellt, muss das Anforderungsobjekt ein FormData-Objekt mit den folgenden Schlüsseln sein:

  • metadata, dessen Wert eine JSON-Zeichenfolge ist, die die Metadaten des Dokuments identifiziert
  • content, dessen Wert dem Inhalt des Dokuments entspricht (und dessen Format je nach Dokumententyp variiert)

Zwei Ansätze für das Buchen von Dokumenten

Es gibt zwei Möglichkeiten, wie eine aufrufende Anwendung ein Dokument erstellen kann:

  1. Buchen (POST) der Metadaten und des Inhalts des Dokuments nach ClaimCenter mit einem /documents-Endpunkt. Bei diesem Ansatz gilt:
    • ClaimCenter fügt das Dokument über einen eigenen Integrationspunkt dem Dokumentenmanagementsystem hinzu.
    • Der Integrationspunkt speichert die vom Dokumentenmanagementsystem erstellten Werte in den Dokumentmetadaten (z. B. die DocUID des Dokuments).
  2. Fügen Sie das Dokument direkt dem Dokumentenmanagementsystem hinzu und buchen (POST) Sie dann die Dokumentenmetadaten nach ClaimCenter. Bei diesem Ansatz gilt:
    • Der POST /documents-Aufruf muss alle erforderlichen Informationen aus dem Dokumentenmanagementsystem in den Metadaten (z. B. die DocUID des Dokuments) bereitstellen.

Mindestkriterien für die Erstellung

Beim Buchen eines Dokuments:

  • Die metadata-JSON muss die folgenden Felder enthalten:
    • name
    • status (ein Typencode aus der Typenliste DocumentStatusType)
    • type (ein Typencode aus der Typenliste DocumentType)
  • Der content-Wert ist nicht erforderlich. Es kann beispielsweise sinnvoll sein, Inhalte wegzulassen, wenn es sich bei dem Dokument um ein physisches Schriftstück handelt, das im Dokumentenmanagementsystem nicht vorhanden ist, oder wenn das Dokument von der aufrufenden Anwendung direkt zum Dokumentenmanagementsystem hinzugefügt wurde.

Beispiele für das Buchen von Dokumenten

Im Folgenden finden Sie ein Beispiel für das Buchen einer Datei „Property Assessment Report.pdf“ für den Schadenfall cc:102 über ClaimCenter.

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

Metadata:
{
    "data": {
        "attributes": {
            "name": "Property Assessment Report",
            "status": {
                "code": "draft"
            },
            "type": {
                "code": "letter_received"			
            }
        }
    }
}

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

Buchen von Dokumenten mit Postman

Warum und wann dieser Vorgang ausgeführt wird

Von Postman aus können Sie mithilfe von POST Dokumente unter Verwendung von FormData-Objekten buchen. Dabei müssen sowohl die Metadaten als auch der Inhalt in separaten Dateien gespeichert werden, auf die durch den Postman-Aufruf verwiesen wird.

Anmerkung: Jeder POST /documents unterstützt die Möglichkeit, die Metadaten entweder als Zeichenfolge oder als Datei zu empfangen. Es ist jedoch ein Problem mit Postman bekannt, welches das Senden von Metadaten als Zeichenfolge verhindert. Bei Verwendung von Postman können die Metadaten nur als Datei gesendet werden. Das wird in folgendem Verfahren beschrieben. (Andere Client-Anwendungen als Postman unterstützen möglicherweise Zeichenfolgen und Dateien.)

Prozedur

  1. Ermitteln Sie die für das FormData-Objekt erforderlichen Dateien. Dazu gehören:
    • eine Textdatei, welche die Metadaten-JSON enthält.
    • die Dokumentdatei mit dem Inhalt.
  2. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  3. Wählen Sie unter der Bezeichnung Untitled Request die Option POST.
  4. Geben Sie im Feld Enter request URL die URL für den Server und den Endpunkt ein.
    • Wenn Sie beispielsweise ein Dokument für einen Schadenfall in einer Instanz von ClaimCenter auf Ihrem Computer mithilfe von POST buchen möchten, geben Sie Folgendes ein: http://localhost:8080/cc/rest/claim/v1/claims/{claimId}/documents
  5. Geben Sie auf der Registerkarte Authorization die entsprechenden Autorisierungsinformationen an.
  6. Geben Sie die Anforderungs-Nutzdaten an.
    1. Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf Body.
    2. Wählen Sie in der Optionsfeldzeile form-data aus.
    3. Geben Sie in der ersten Zeile für KEY Folgendes ein: metadata
    4. Klicken Sie außerhalb der metadata-Zelle. Bewegen Sie dann die Maus über die rechte Seite der Zelle. Eine Dropdown-Liste wird angezeigt. Ändern Sie den Wert von Text in File.
    5. Klicken Sie für VALUE auf die Schaltfläche Select Files und navigieren Sie zu der Datei, die die JSON-formatierten Metadaten enthält.
    6. Geben Sie in der zweiten Zeile für KEY Folgendes ein: content
    7. Klicken Sie außerhalb der content-Zelle. Bewegen Sie dann die Maus über die rechte Seite der Zelle. Eine Dropdown-Liste wird angezeigt. Ändern Sie den Wert von Text in File.
    8. Klicken Sie für VALUE auf die Schaltfläche Select Files und navigieren Sie zu der Datei, welche die Dokumentinhalte enthält.
  7. Klicken Sie auf Senden. Die Antwort-Nutzdaten werden unterhalb der Anforderung-Nutzdaten angezeigt.