HTTP-Header angeben

Bestimmte Anforderungsanpassungen erfordern das Festlegen von HTTP-Headern. Die Header "Content-Type" und "Accept" steuern das Eingabe- und Ausgabeformat. Der Header "Range" steuert die Paginierung. Der Header "Compression" steuert die Komprimierung.

Header "Content-Type" und "Accept"

Geben Sie die Inhaltstypen des Anforderungshauptteils und der Anforderungsausgabe mithilfe der Header "Content-Type" und "Accept" an.

Tabelle 1. Werte der Header "Content-Type" und "Accept"
Headername Wert Beschreibung
Content-Type application/json Gibt das Format des Anforderungshauptteils als "JSON" an.
application/xml Gibt das Format des Anforderungshauptteils als "XML" an.
application/x-www-form-urlencoded Gibt an, dass der Anforderungshauptteil URL-codiert ist.
Accept application/json Legt den Ausgabetyp auf JSON fest.
application/json;indent=2 Legt den Ausgabetyp auf formatiertes JSON fest.
application/xml Legt den Ausgabetyp auf XML fest.

Bereich

Der Header Range steuert die Paginierung in "list"-API-Aufrufen.

Tabelle 2. Werte des Headers "Range"
Headername Wert Beschreibung
Range items=x-y Gibt Datensätze mit den Zeilen-IDs x bis yzurück Alternativ können Sie den Bereich in der URL der Anforderung mit dem Parameter _range=x-yangeben.

Komprimierung

Legen Sie zum Komprimieren der Daten in einer Antwort den Header Accept-Encoding fest.

Tabelle 3. Werte des Headers "Compression"
Headername Wert Beschreibung
Accept-Encoding gzip Gibt komprimierte Ergebnisse im "GNU .ZIP"-Format an.
identity Gibt Ergebnisse mit Identitätscodierung (keine Transformation) zurück.

X-HTTP-Method-Override

Wenn Sie in einer Anforderung kein HTTP-Verb verwenden können, senden Sie eine POST-Anforderung mit dem Verb als Wert für den Überschreibungsheader. Die Anforderung verhält sich so, als ob der Aufruf mit dem im Überschreibungsheader angegebenen HTTP-Verb ausgegeben würde.

Wenn Sie beispielsweise keine DELETE-Anforderung für die Auftragsnummer 12345 übergeben können, legen Sie den Header X-HTTP-Method-Override auf DELETE fest und verwenden Sie die HTTP-Anforderung:
POST http://host:port/contextRoot/restapi/order/12345
Sie können den Header X-HTTP-Method-Override auch verwenden, um Parameter in GET-Anforderungen zu übergeben, die das Größenlimit einer URL überschreiten. Senden Sie ein POST-Element an die URL, legen Sie den Header Content-Type auf application/x-www-form-urlencoded fest und legen Sie den Header X-HTTP-Method-Override auf GET fest.
Tabelle 4. Werte des Headers "X-HTTP-Method-Override"
Kopfname Wert
X-HTTP-Method-Override GET
  PATCH
  DELETE