Gibt eine Streaming Response der verfügbaren Zeitabschnitte in einem bestimmten Zeitbereich und einer Zeitabschnittsablage zurück. Die zurückgegebenen Infofelder in der Response können gefiltert werden.

Message "GetHdTimePeriodDataRequest"

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken -> 
GetHdTimePeriodDataRequest{
   QueryMode{…}
   ColumnFilter{…}
}

Parameter

Pos.

Parameter

Datentyp

Bedeutung

1

hd_store_name

string

Eindeutiger Name der zeitbasierten HD-Ablage, die die übergeordnete Ablage für die Zeitabschnittsablage ist.

2

time_period_store_name

string

Eindeutiger Name des Zeitabschnitts, der von Interesse ist.

3

time_range_from

int64

Startzeit des Request-Zeitbereichs im Unix-Zeitstempelformat in Mikrosekunden.

4

time_range_to

int64

Endzeit des Request-Zeitbereichs im Unix-Zeitstempelformat in Mikrosekunden.

5

query_mode

-

Der Modus legt fest, ob Start- und Endzeit im Abfragezeitbereich enthalten sind oder nicht, siehe Message "QueryMode".

Standardmäßig sind alle Werte falsch und es wird keine Sortierreihenfolge angewendet.

6

filter

-

Filter für angeforderte Infofelder, siehe Message "ColumnFilter".

Standardmäßig wird kein Filter angewendet.

7

max_sample_count_per_message

int64

Angabe, wie viele Zeitabschnitte in einer einzigen Message gesendet werden sollen, bevor eine neue Message gestartet wird (Chunk-Streaming).

8

limit

int64

Angabe der maximalen Anzahl von Zeitabschnitten, die insgesamt gesendet werden können. Über das Feld order_by können Sie bestimmen, welche Zeitabschnitte übersprungen werden, falls mehr Zeitabschnitte verfügbar sind.
Message "GetHdTimePeriodDataResponse"

Gibt die Liste der Zeitabschnittseinträge mit Start- und Endzeit im Unix-Zeitstempelformat in Mikrosekunden zurück. Für jeden Zeitabschnitt wird eine Message TimePeriodData mit folgenden Parametern zurückgegeben.

Alle Standardwerte der Infofelder werden standardmäßig hinzugefügt. Die nach Info_field_names gefilterten benutzerdefinierten Infofelder werden hinzugefügt und nach Variablentyp geordnet.

Struktur

Zum Kopieren in die Zwischenablage auf das Icon klicken -> 
GetHdTimePeriodDataResponse{
   TimePeriodData{
      NumericField{…}
      Int32Field{…}
      Int64Field{…}
      TextField{…}
      DigitalField{…}
   }
}

Parameter

Pos.

Parameter

Datentyp

Bedeutung

1

id

int64

Eindeutige ID des Zeitabschnitts

2

start_time

int64

Unix-Zeitstempel für die Startzeit des Zeitabschnitts in Mikrosekunden.

3

end_time

int64

Unix-Zeitstempel für die Endzeit des Zeitabschnitts in Mikrosekunden.

Für Zeitabschnitte ohne gültige Endzeit wird eine "0" zurückgegeben.

4

name

string

Name des Zeitabschnittseintrags

5

start_trigger

double

Absolute Zeit in Sekunden im Verhältnis zur Startzeit

6

stop_trigger

double

Absolute Zeit in Sekunden, zu dem die Startzeit im Verhältnis zur Startzeit eintrat. Der Wert ist 0,0, wenn kein Stopptrigger aufgetreten ist.

7

comment

string

Kommentar

8

metadata_id

int32

ID der für diesen Zeitabschnitt verwendeten Metadatengruppe

9

double_fields

-

Infofelder vom Typ "double", siehe Message "NumericField".

10

int32_fields

-

Infofelder vom Typ "int32", siehe Message "Int32Field".

11

int64_fields

-

Infofelder vom Typ "int64", siehe Message "Int64Field".

12

text_fields

-

Textinfofelder, siehe Message "TextField".

13

digital_fields

-

Infofelder vom Typ "bool", siehe Message "DigitalField".

14

autoClosed

bool

True, wenn der Zeitabschnitt die maximale Zeitabschnittsdauer vor dem Stopp-Trigger erreicht, und automatisch geschlossen wurde

15

dataMissing

bool

True, wenn Daten innerhalb des Zeitabschnitts fehlen, z. B. wenn die Datenaufzeichnung unterbrochen wurde
Message "QueryMode"

Pos.

Parameter

Datentyp

Bedeutung

1

is_start_time_in_time_range

bool

Legt fest, ob die Startzeit der Zeitabschnitte in die Abfrage einbezogen werden soll oder ob die Startzeit vor dem abgefragten Zeitbereich liegt

2

is_end_time_in_time_range

bool

Legt fest, ob der Endzeitpunkt der Zeitabschnitte in die Abfrage einbezogen werden soll oder ob der Endzeitpunkt später als das Ende des abgefragten Zeitbereichs liegen kann

3

include_open

bool

Angabe, ob nicht abgeschlossene Zeitabschnitte in das Ergebnis einbezogen werden oder nur abgeschlossene Zeiträume mit Start- und Endzeit verwendet werden

4

column_filter_active

bool

Spaltenfilter aktivieren oder deaktivieren

5

order_by

enum (OrderByType)

Ergebnisse nach der Startzeit in aufsteigender oder absteigender Reihenfolge ordnen
Message "ColumnFilter"

Pos.

Parameter

Datentyp

Bedeutung

1

info_field_names

string

Es werden nur die Infofelder abgefragt, die als Filter angegeben sind.

Die vollständige Liste der verfügbaren Feldnamen können Sie mit GetHdTimePeriodStoreSchema() anfordern, siehe GetHdTimePeriodStoreSchema().
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 "Int32Field"

Pos.

Parameter

Datentyp

Bedeutung

1

name

string

Name des Feldes

2

value

int32

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 "Int64Field"

Pos.

Parameter

Datentyp

Bedeutung

1

name

string

Name des Feldes

2

value

int64

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.
Message "DigitalField"

Pos.

Parameter

Datentyp

Bedeutung

1

name

string

Name des Feldes

2

value

bool

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