GetEventData()

Liefert alle Ereignisse für die bereitgestellten Ereigniskanäle und den angegebenen Zeitbereich zurück. Zusätzliche Ereignisfelder, die zusammen mit dem Ereignis gespeichert werden, können optional in der Anfrage ausgewählt werden.

Message "GetEventDataRequest"

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken ->

GetEventDataRequest{
}

Parameter

Pos.	Parameter	Datentyp	Bedeutung
1	time_range_from	int64	Anfangszeit des angeforderten Zeitbereichs im Unix-Zeitstempelformat in Mikrosekunden
2	time_range_to	int64	Endzeit des angeforderten Zeitbereichs im Unix-Zeitstempelformat in Mikrosekunden
3	limit_per_channel	int64	Begrenzung der Anzahl der Ereignisse, die pro Kanal zurückgegeben werden, Standard (Wert = 0) 1000 -1 bedeutet keine Begrenzung
4	order_by	enum(OrderByType)	Chronologische Reihenfolge, in der die Ereignisse zurückgegeben werden, siehe Enum "OrderByType". Standardmäßig ORDER_BY_TYPE_DESCENDING, wenn nicht angegeben
5	channel_ids	string	Kanal-IDs im gleichen Format, wie sie in der Response-Liste von GetHdStoreSchema() zurückgegeben werden, siehe GetHdStoreSchema().
6	acknowledgements	bool	Abfrage optionaler Details über die Quittierung von Ereignissen durch den Benutzer
7	numeric_fields	string	Abfrage von optionalen numerischen Feldern in der Response Message für jedes Ereignis, das die angegebenen Felder enthält
8	text_fields	string	Abfrage von optionalen Textfeldern in der Response Message für jedes Ereignis, das die angegebenen Felder enthält

Message "GetEventDataResponse"

Listet alle Ereignisse im definierten Zeitbereich. Pro Ereignis wird eine Message Event zurückgegeben mit den folgenden Parametern.

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken ->

GetEventDataResponse{
   Event{
      EventAcknowledgement{…}
      NumericField{…}
      TextField{…}
   }
}

Parameter

Pos.	Parameter	Datentyp	Bedeutung
1	channel_id	string	Vollständig qualifizierte ID im Format `<HD store name>\<event channel id>` Beispiel: `store_1\[0]`
2	timestamp	int64	Unix-Zeitstempel in Mikrosekunden, der das Ende des Ereignisses markiert
3	duration	int64	Dauer des Ereignisses in Mikrosekunden bis zum Zeitstempel
4	message	string	Konfigurierte Nachricht oder vom Benutzer eingegebene Anmerkung zum Ereignis
5	trigger	enum(EventTriggerType)	Legt fest, ob das Ereignis ein eingehendes oder ein ausgehendes Ereignis ist, siehe Enum "OrderByType"
6	event_acknowledgement	-	Optionale Angaben zur Bestätigung von Ereignissen durch den Benutzer, siehe Message "EventAcknowledgement". Standardwert null, wenn nicht angefordert
7	numeric_fields	-	Optionale numerische Feldwerte des Ereignisses, siehe Message "NumericField". Standardmäßig leer, wenn nicht angefordert
8	text_fields	-	Optionale Textfeldwerte des Ereignisses, siehe Message "TextField". Standardmäßig leer, wenn nicht angefordert

Message "EventAcknowledgement"

Pos.	Parameter	Datentyp	Bedeutung
1	acknowledged	enum(AckType)	Status der Quittierung
2	acknowledge_comment	string	Benutzerdefinierter Kommentar der Quittierung
3	acknowledge_timestamp	int64	Unix-Zeitstempel in Mikrosekunden, wenn acknowledged = ACK_TYPE_ACKNOWLEDGED, sonst 0
4	acknowledge_os_user	string	OS-Benutzer, der angemeldet war, als das Ereignis quittiert wurde
5	acknowledge_iba_hdserver_user	string	ibaHD-Server-Benutzer, der angemeldet war, als das Ereignis quittiert wurde
6	acknowledge_iba_pda_user_user	string	ibaPDA-Benutzer, der angemeldet war, als das Ereignis quittiert wurde

Message "NumericField"

Pos.	Parameter	Datentyp	Bedeutung
1	name	string	Name des Feldes
2	value	double	Wert des Feldes
3	isData	bool	Ist TRUE, wenn der aktuelle Wert entweder wahr oder falsch ist, und ist FALSE, wenn der aktuelle Wert null ist.

Message "TextField"

Pos.	Parameter	Datentyp	Bedeutung
1	name	string	Name des Feldes
2	value	double	Wert des Feldes
3	isData	bool	Ist TRUE, wenn der aktuelle Wert entweder wahr oder falsch ist, und ist FALSE, wenn der aktuelle Wert null ist.

Enum "OrderByType"

Folgende Werte stehen für OrderByType zur Verfügung.

Wert		Bedeutung
0	ORDER_BY_TYPE_UNSPECIFIED	nicht spezifiziert
1	ORDER_BY_TYPE_DESCENDING	Absteigende Reihenfolge
2	ORDER_BY_TYPE_ASCENDING	Aufsteigende Reihenfolge

Enum "EventTriggerType"

Wert		Bedeutung
0	EVENT_TRIGGER_TYPE_UNSPECIFIED	nicht spezifiziert
1	EVENT_TRIGGER_TYPE_INCOMING	Eingehendes Ereignis
2	EVENT_TRIGGER_TYPE_OUTGOING	Ausgehendes Ereignis

Enum "AckType"

Wert		Bedeutung
0	ACK_TYPE_UNSPECIFIED	nicht spezifiziert
1	ACK_TYPE_ACKNOWLEDGED	Status "quittiert"
2	ACK_TYPE_NOT_ACKNOWLEDGED	Status "nicht quittiert"
3	ACK_TYPE_PENDING	Status "ausstehend"