Benutzer-Werkzeuge

Webseiten-Werkzeuge


rest_api

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
rest_api [2019/10/18 12:47] – [REST API] lwsystemsrest_api [2023/11/02 09:56] (aktuell) – [Optionale Parameter] lwsystems
Zeile 1: Zeile 1:
- 
- 
 ====== REST API ====== ====== REST API ======
  
Zeile 121: Zeile 119:
 ==== Suche in einem Zeitraum  ==== ==== Suche in einem Zeitraum  ====
  
-<code>?archive=BennoContainer&amp;query=((Sender:*hansen-und-meyer*)) AND (Date:[201308231020 TO 201308271605]))</code>+<code>?archive=BennoContainer&query=((Sender:*hansen-und-meyer*) AND (Date:[201308231020 TO 201308271605]))</code>
  
 Hier werden die E-Mails im Zeitraum zwischen 23.08.2013 10:20 und dem 27.08.2013 um 16:05 gesucht. Hier werden die E-Mails im Zeitraum zwischen 23.08.2013 10:20 und dem 27.08.2013 um 16:05 gesucht.
  
-//Anmerkung//: Ein Bereich kann als **[**inklusiv**]** oder **{**exklusiv**}** formatiert definiert werden. 
  
-  * ''Date:[197001010000 TO 201512312400]'' - inklusiver Bereich, Ergebnisse bis zum 31.12.2015 24:00 
-  * ''Date:{197001010000 TO 201512312400}'' - exklusiver Bereich, Ergebnisse nach dem 31.12.2015 24:00 
 ==== Suchanfrage mit Filterung  ==== ==== Suchanfrage mit Filterung  ====
  
Zeile 176: Zeile 171:
 Die aus dem Archiv gelesene E-Mail wird standardmäßig als JSON Objekt an das aufrufende Programm zurückgegeben. Mittels der Option format kann die Rückgabe der E-Mail im „raw“ Format, also RFC 822 bzw. RFC 2822 (Plaintext) erzwungen werden.  Die aus dem Archiv gelesene E-Mail wird standardmäßig als JSON Objekt an das aufrufende Programm zurückgegeben. Mittels der Option format kann die Rückgabe der E-Mail im „raw“ Format, also RFC 822 bzw. RFC 2822 (Plaintext) erzwungen werden. 
  
-  *format: „raw“, wenn die Mail im RFC-822 Format zurückgegeben werden soll.+  * format=raw - E-Mail im RFC-822 Format anfordern 
 +  * skipUTF8Recode=true - E-Mail im Orginal zurück geben 
 +  * header=true - Secret Header zurück geben
  
 +**Achtung!** Um eine E-Mail aus dem Repo zum Re-Indexieren ist es erforderlich, die E-Mail ohne Anpassung des Encodings zu laden. Daher ist hier der Parameter //skipUTF8Recode=true// zwingend erforderlich.
 ===== Rückgabewerte eines Abrufs einer E-Mail aus dem Archiv  ===== ===== Rückgabewerte eines Abrufs einer E-Mail aus dem Archiv  =====
 ==== Resultatwerte (HTTP-Fehlercodes der Suchoperation):  ==== ==== Resultatwerte (HTTP-Fehlercodes der Suchoperation):  ====
rest_api.1571402877.txt.gz · Zuletzt geändert: 2019/10/18 12:47 von lwsystems