Senden von POSTs

Sie verwenden ein Anforderungstool, z. B. Postman, um sicherzustellen, dass POSTs wohlgeformt sind, und um die Struktur der Antwort-Nutzdaten zu überprüfen. Weitere Informationen finden Sie unter Anforderungen und Antworten.

POST mit Postman senden

Prozedur

  1. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  2. Geben Sie als Basic Auth-Autorisierung den Benutzer aapplegate und das Kennwort gw an.
  3. Stellen Sie sicher, dass unter der Bezeichnung Untitled Request POST ausgewählt ist.
  4. Geben Sie im Feld Enter request URL die URL für den Server und den Endpunkt ein.
    • Um beispielsweise eine neue Notiz für die Aktivität cc:2 in einer Instanz von ClaimCenter auf Ihrem Computer zu erstellen, geben Sie Folgendes ein: http://localhost:8080/cc/rest/common/v1/activities/cc:2/notes
  5. 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 raw aus.
    3. Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
    4. Fügen Sie die Anforderungs-Nutzdaten in das Textfeld unter den Optionsfeldern ein.
  6. Klicken Sie auf Senden. Die Antwort-Nutzdaten werden unterhalb der Anforderung-Nutzdaten angezeigt.

Lernprogramm: Neue Notiz erstellen, die nur Pflichtfelder angibt

In diesem Lernprogramm wird davon ausgegangen, dass Sie Postman in Ihrer Umgebung mit dem korrekten Beispieldatensatz eingerichtet haben. Weitere Informationen finden Sie unter Lernprogramm: Einrichten Ihrer Postman-Umgebung.

In diesem Tutorial erstellen Sie eine Notiz mit dem Betreff "API-Tutorial-Notiz 1" für eine vorhandene Aktivität. Die anderen Felder werden nicht angegeben und werden von der Anwendung mit Standardwerten belegt (z. B. nicht vertraulich und mit dem Betreff "Allgemein").

Schritte des Lernprogramms

  1. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  2. Geben Sie als Basic Auth-Autorisierung den Benutzer aapplegate und das Kennwort gw an.
  3. Geben Sie den folgenden Aufruf ein und klicken Sie dann auf Senden:

    GET http://localhost:8080/cc/rest/common/v1/activities

  4. Ermitteln Sie die id der ersten Aktivität in den Nutzdaten. (cc:20.)
  5. Geben Sie den folgenden Aufruf ein, klicken Sie aber noch nicht auf Senden:

    POST http://localhost:8080/cc/rest/common/v1/activities/cc:20/notes

  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 raw aus.
    3. Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
    4. Kopieren Sie Folgendes in das Textfeld unter den Optionsfeldern.
      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 1"
                }
        }
}
  7. Klicken Sie auf Senden. Die Antwort-Nutzdaten werden unterhalb der Anforderung-Nutzdaten angezeigt.

Ihre Arbeit überprüfen

  1. Zeigen Sie die neue Notiz in ClaimCenter an.
    1. Notieren Sie sich in den Antwort-Nutzdaten die Schadenfallnummer des Schadenfalls, auf den sich diese Notiz bezieht. (Sie befindet sich in Zeile 13. Die Schadenfallnummer lautet 235-53-365889.)
    2. Melden Sie sich am ClaimCenter als aapplegate an und navigieren Sie zum Schadenfall.
    3. Klicken Sie auf Notizen.

Die API-Tutorial-Notiz sollte als eine der Notizen aufgeführt werden.

Lernprogramm: Neue Notiz erstellen, die optionale Felder angibt

In diesem Lernprogramm wird davon ausgegangen, dass Sie Postman in Ihrer Umgebung mit dem korrekten Beispieldatensatz eingerichtet haben. Weitere Informationen finden Sie unter Lernprogramm: Einrichten Ihrer Postman-Umgebung.

In diesem Tutorial erstellen Sie eine Notiz mit dem Betreff "API-Tutorial-Notiz 2" für eine vorhandene Aktivität. Außerdem geben Sie Werte für zwei optionale Felder an: vertraulich (true) und Betreff (litigation).

Schritte des Lernprogramms

  1. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  2. Geben Sie als Basic Auth-Autorisierung den Benutzer aapplegate und das Kennwort gw an.
  3. Geben Sie den folgenden Aufruf ein und klicken Sie dann auf Senden:

    GET http://localhost:8080/cc/rest/common/v1/activities

  4. Ermitteln Sie die id der ersten Aktivität in den Nutzdaten. (cc:20.)
  5. Geben Sie den folgenden Aufruf ein, klicken Sie aber noch nicht auf Senden:

    POST http://localhost:8080/cc/rest/common/v1/activities/cc:20/notes

  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 raw aus.
    3. Ändern Sie am Ende der Zeile mit den Optionsfeldern den Wert der Dropdown-Liste von Text in JSON.
    4. Kopieren Sie Folgendes in das Textfeld unter den Optionsfeldern. 
      {
    "data":
        {
            "attributes": {
                "body": "API tutorial note 2",
                "confidential": true,
                "topic": {
                    "code": "litigation"
                }
            }
        }
}
  7. Klicken Sie auf Senden. Die Antwort-Nutzdaten werden unterhalb der Anforderung-Nutzdaten angezeigt.

Ihre Arbeit überprüfen

  1. Zeigen Sie die neue Notiz in ClaimCenter an.
    1. Notieren Sie sich in den Antwort-Nutzdaten die Schadenfallnummer des Schadenfalls, auf den sich diese Notiz bezieht. (Sie befindet sich in Zeile 13. Die Schadenfallnummer lautet 235-53-365889.)
    2. Melden Sie sich am ClaimCenter als aapplegate an und navigieren Sie zum Schadenfall.
    3. Klicken Sie auf Notizen.

Die API-Tutorial-Notiz sollte als eine der Notizen aufgeführt werden. Diese Notiz ist vertraulich und enthält die Kategorie, die in den Anforderungs-Nutzdaten angegeben ist.