APIResponse¶

Kurzbeschreibung¶

APIResponse ist ein Outlet Brick. Er versendet eine Antwort auf Anfrage über den Endpoint-Provider.

Input¶

APIResponse besitzt einen Input-Port.

    Response = {
    "RequestId" -> string,
    "Request" -> <string -> variant>
};

Als Input empfängt APIResponse eine Map aus zwei Elementen. RequestId ist eine Identifikationsnummer der Anfrage. Sie wird vom Endpunkt-Provider vergeben wird. Request ist die Antwort (Body), die der Anfrage zu zuordnen ist.

Parametrisierung¶

APIResponse besitzt folgende Parameter:

Status
Type
EndpointID

Alle Parameter sind nicht direkt durch den Nutzer konfigurierbar. Sie werden automatisch vom FlowManager gesetzt, abhängig davon, welche vom Nutzer angelegte API und welcher Endpoint gewählt werden.

Status¶

Status ist ein http-Statuscode, der als Antwort auf die Anfrage versendet werden soll

Standardwert : 200
integer

Type¶

Type ist der Typ des Bodys der Response. In der Response wird der entsprechende Header gesetzt. Aktuell werden die Typen “TEXT” und “JSON” unterstützt.

Standardwert : 200
string

EndpointID¶

EndpointID ist ein Hilfsparameter, der dem FlowManager erlaubt Neu- von Umkonfigurationen zu unterscheiden.

Standardwert : ``
string

Funktion¶

APIResponse kommuniziert mit dem Endpoint-Provider mittels zmq. Zu erst registriert sich APIResponse bei dem Endpoint-Provider. Anschließend werden die Flow Pakete weitergeleitet zum Endpoint-Provdier. Sollte der Endpoint-Provider nicht funktionieren, schaltet sich APIResponse ab.

Python-Module¶

APIResponse benutzt folgende Python-Module:

zmq