HTTP-Header

Anforderungs- und Antwortobjekte werden von REST-APIs verwendet, um Informationen zwischen Anwendungen zu senden. Diese Objekte enthalten HTTP-Header. Ein HTTP-Header ist ein Name/Wert-Paar, das in einem Anforderungs- oder Antwortobjekt enthalten ist, das Metadaten über die Anforderung oder Antwort bereitstellt. Ein HTTP-Header kann Informationen angeben wie:

  • Das im Anforderungsobjekt verwendete Format (z. B. JSON oder XML)
  • Das im Antwortobjekt zu verwendende Format
  • Sitzungs- und Verbindungsinformationen
  • Autorisierungsinformationen

Übersicht über Cloud-API-Header

Cloud-API unterstützt Standard-HTTP-Header wie Autorisierung und Content-Type.

Die Cloud-API unterstützt auch die folgenden Guidewire-proprietären Header. Jeder Guidewire-proprietäre Header ist optional.

Kopfzeile Datentyp Beschreibung
GW-Checksum Zeichenfolge

Dadurch kann verhindert werden, dass Aktualisierungen verloren gehen.

Wenn die festgelegt ist und der Aufruf zu einer Datenbankübergabe führen würde, lässt die API die Übergabe nur zu, wenn die Prüfsumme im Header mit dem Prüfsummenwert aus ClaimCenter übereinstimmt.

Weitere Informationen finden Sie unter Prüfsummen.
GW-DBTransaction-ID

Zeichenfolge mit bis zu 128 Zeichen

Dadurch können doppelte Anforderungen verhindert werden.

Wenn sie angegeben ist, wird sie als Datenbank-Transaktions-ID für diese Anforderung verwendet. Die System-API lässt die Übergabe nur zu, wenn der Wert des Headers nicht durch eine vorherige Anforderung übermittelt wurde. Der Wert wird in der ClaimCenter-Datenbank gespeichert und muss auf allen Clients, APIs und Webdiensten global eindeutig sein.

Weitere Informationen finden Sie unter Verhindern doppelter Datenbanktransaktionen.
GW-DoNotCommit

Boolescher Wert

Damit können Endpunkte aufgewärmt werden.

In der Regel wird dies von einer aufrufenden Anwendung auf einem Dummy-POST angegeben, der vor echten Geschäftsanforderungen gesendet wird. Der POST löst "Aufwärm"-Aktivitäten für den Endpunkt aus, z. B. das Laden von Java- und Gosu-Klassen. Der Header verhindert jedoch, dass Daten übergeben werden. Diese Anforderung kann die Leistung nachfolgender Anforderungen an diesen Endpunkt verbessern.

Weitere Informationen finden Sie unter Aufwärmen eines Endpunkts.
GW-IncludeSchemaProperty Boolescher Wert

Dadurch kann das Format der JSON-Nutzdaten geändert werden.

Wenn dieser Parameter auf "True" gesetzt ist und der Vorgang JSON mit einem definierten Schema zurückgibt, wird die $GW-Schema-Eigenschaft zum Root-JSON-Objekt der Antwort mit dem vollständig qualifizierten Namen der JSON-Schemadefinition für dieses Objekt hinzugefügt. Die Standardeinstellung lautet "False".
GW-Language Zeichenfolge

Damit wird die Sprache festgelegt, die bei der Verarbeitung der Anforderung verwendet wird.

Weitere Informationen finden Sie unter Globalisierung.
GW-Locale Zeichenfolge

Damit wird das Gebietsschema festgelegt, das bei der Verarbeitung der Anforderung verwendet wird.

Weitere Informationen finden Sie unter Globalisierung.
GW-UnknownPropertyHandling

Einer dieser Zeichenfolgenwerte:

  • log
  • reject
  • ignore

Damit wird das Verhalten für die Verarbeitung von Anforderungs-Nutzdaten mit unbekannten Eigenschaften angegeben. Das Standardverhalten ist reject.

Weitere Informationen finden Sie unter Bearbeiten eines Aufrufs mit unbekannten Elementen.

GW-UnknownQueryParamHandling

Einer dieser Zeichenfolgenwerte:

  • log
  • reject
  • ignore

Damit wird das Verhalten für die Verarbeitung von URLs mit unbekannten Abfrageparametern angegeben. Das Standardverhalten ist reject.

Weitere Informationen finden Sie unter Bearbeiten eines Aufrufs mit unbekannten Elementen.
GW-User-Context Zeichenfolge

Dies liefert Informationen über den dargestellten Benutzer, wenn ein Dienst einen Service-for-User- oder Service-for-Service-Anruf durchführt.

Weitere Informationen finden Sie im Cloud-API-Authentifizierungshandbuch.

GW-ValidateResponseHandling

 Boolescher Wert

Fordert an, dass der Server eine zusätzliche Validierung von REST-API-Antworten für Beschränkungen wie maxLength durchführt, die im Schema deklariert sind. Standardmäßig deaktiviert, kann aber in einigen Kontexten zum Testen oder Debuggen benutzerdefinierter APIs nützlich sein.

Weitere Informationen finden Sie unter Validieren von Antwort-Nutzdaten anhand zusätzlicher Einschränkungen.
x-gwre-session Zeichenfolge

Dies steuert, wie zugehörige Aufrufe in Instanzen von ClaimCenter weitergeleitet werden, die in einem Cluster ausgeführt werden.

(Hinweis: Dieser Header ist nicht exklusiv für die Cloud-API und entspricht daher nicht der Konvention, "GW-" am Anfang von Headernamen zu verwenden.)

Weitere Informationen finden Sie unter Routing von zugehörigen API-Aufrufen in Cluster-Umgebungen.
X-Correlation-ID Zeichenfolge

Damit kann ein Kunde eine Anforderung vom ersten Eingang an durch alle nachfolgenden Anwendungen verfolgen, die zur Bearbeitung dieser Anforderung aufgerufen wurden.

Die tatsächliche Rückverfolgbarkeits-ID, die im MDC und in den Protokollen vorhanden ist (und in der Antwort zurückgegeben wird), hängt von der Implementierung des TraceabilityIDPlugin-Plugins ab. Die Standardimplementierung verwendet diesen Wert, sofern angegeben, oder eine generierte UID. Eine andere Implementierung kann jedoch immer eine eindeutige ID generieren und die Verhältnis zwischen diesen eingehenden Werten und der generierten UID protokollieren. Dieser Header kann wiederholt werden, aber die resultierende Zeichenfolge sind nur die durch Kommas getrennten Werte.

(Hinweis: Dieser Header stammt aus der Zeit vor dem REST API Framework und wurde vor der Verwendung von "GW-" am Anfang der Headernamen erstellt.)

Anforderung mit einem Cloud-API-Header über Postman senden

Warum und wann dieser Vorgang ausgeführt wird

Sie können Cloud-API-Header in Aufrufen einschließen, die von Postman ausgeführt werden.

Prozedur

  1. Starten Sie in Postman eine neue Anforderung, indem Sie auf das + rechts neben der Registerkarte Launchpad klicken.
  2. Geben Sie die entsprechende Autorisierung an.
  3. Fügen Sie den Header und den Headerwert hinzu.
    • Klicken Sie in der ersten Zeile der Registerkarten (die mit Params beginnt) auf Headers.
    • Scrollen Sie zum Ende der bestehenden Schlüssel-/Wertliste.
    • Geben Sie in der leeren Zeile am Ende der Schlüssel-/Wertliste den Headernamen in der Spalte KEY und seinen Wert in der Spalte VALUE ein.
  4. Geben Sie den Anforderungsvorgang und die URL ein.
  5. Klicken Sie auf Senden.