Zugriff via HTTP POST/GET

Produkt	Gültig Ab Version	Status
FE2	2.15	VERÖFFENTLICHT

Zugriff via HTTP POST

Datenübertragung via HTTP POST. Muss im Input-Plugin aktiviert werden.

Zugriff

Daten

UTF-8 kodiertes JSON als Body eines HTTP POST Aufrufs

Return-Werte

Es werden die Standard-HTTP-Return-Codes verwendet.

HTTP Code	Bedeutung
200	Alarm erfolgreich übergeben
400	Der Aufruf war fehlerhaft

Beispiel Return Objekt

{
  "status":"OK|NOT_OK",
  "error":"Error message"
}

Als Body wird ein UTF-8 kodiertes JSON zurückgeliefert:

Zugriff via HTTP GET

Datenübertragung via HTTP GET. Muss im Input-Plugin aktiviert werden.

Warnung

Bei dieser Variante wird der Absender nicht überprüft! Sie sollten diese Schnittstelle also nur in lokalen Netzwerken erlauben, welche Sie unter Ihrer Kontrolle haben.

Zugriff

GET IP:PORT/rest/external/http?message=Text&param1=value1&param2=value2

IP	Die IP-Adresse des Rechners, auf dem FE2 läuft oder localhost, falls der Zugriff vom selben System erfolgt
Port	Der Port, über welchen auch die Weboberfläche zur Verfügung steht (unter Einstellungen konfigurierbar)
message	Der einzige Parameter, welcher vorgeschrieben ist. Dies ist der Alarmtext

Daten

Alle Daten können via URL Parameter im Format key=value übergeben werden. Welche URL Parameter beachtet werden, definieren Sie im Alarmeingang unter GET Parameter in folgendem Format:

QueryParameter;FE2Parameter

QueryParameter

Geben Sie hier an, wie der entsprechende Query Parameter heißt

FE2Parameter

Unter diesem Parameter wird dann der entsprechende Wert gespeichert.

Verwendung von message

Message wird innerhalb der URL immer als Pflichtparameter erwartet.

Verwendung von address

Sollten Sie hier address angeben, wird der QueryParameter als Feld address alarmiert, wodurch spezifische Einheiten direkt alarmiert werden können

Ein Beispiel könnte so aussehen:

Alarmtext;message
Liste;address
Straße;street

Return-Werte

Es werden die Standard-HTTP-Return-Codes verwendet.

200	Alarm erfolgreich übergeben
400	Der Aufruf war fehlerhaft

Als Body wird ein einfaches OK oder NOK zurückgeliefert