Returns all events for the provided event channels and the specified time range. Additional event fields, which are saved together with the event, can optionally be selected in the request.

Message "GetEventDataRequest"

Structure

To copy the code to the clipboard click on the icon -> 
GetEventDataRequest{
}

Parameter

Pos.

Parameter

Data type

Meaning

1

time_range_from

int64

Start time of the requested time range in Unix time stamp format in microseconds

2

time_range_to

int64

End time of the requested time range in Unix time stamp format in microseconds

3

limit_per_channel

int64

Limits the number of events that are returned per channel,

Standard (value = 0) 1000

-1 means no limitation

4

order_by

enum(OrderByType)

Chronological order in which the events are returned, see Enum "OrderByType".

ORDER_BY_TYPE_DESCENDING by default, if not specified

5

channel_ids

string

Channel IDs in the same format as they are returned in the response list of GetHdStoreSchema(), see GetHdStoreSchema().

6

acknowledgements

bool

Query optional details about the acknowledgement of events by the user

7

numeric_fields

string

Query optional numeric fields in the response message for each event that contains the specified fields

8

text_fields

string

Query of optional text fields in the response message for each event that contains the specified fields
Message "GetEventDataResponse"

Lists all events in the defined time range. A message Event is returned for each event with the following parameters.

Structure

To copy the code to the clipboard click on the icon -> 
GetEventDataResponse{
   Event{
      EventAcknowledgement{…}
      NumericField{…}
      TextField{…}
   }
}

Parameter

Pos.

Parameter

Data type

Meaning

1

channel_id

string

Fully qualified ID in the format <HD store name>\<event channel id>

Example: store_1\[0]

2

timestamp

int64

Unix timestamp in microseconds that marks the end of the event

3

duration

int64

Duration of the event in microseconds until the time stamp

4

message

string

Configured message or user-entered comment on the event

5

trigger

enum(EventTriggerType)

Determines whether the event is an incoming or outgoing event, see Enum "OrderByType"

6

event_acknowledgement

-

Optional information for the confirmation of events by the user, see Message "EventAcknowledgement".

Default value zero if not requested

7

numeric_fields

-

Optional numerical field values of the event, see Message "NumericField".

Empty by default if not requested

8

text_fields

-

Optional text field values of the event, see Message "TextField".

Empty by default if not requested
Message "EventAcknowledgement"

Pos.

Parameter

Data type

Meaning

1

acknowledged

enum(AckType)

State of the acknowledgment

2

acknowledge_comment

string

User-defined acknowledgment comment

3

acknowledge_timestamp

int64

Unix time stamp in microseconds, if acknowledged = ACK_TYPE_ACKNOWLEDGED, otherwise 0

4

acknowledge_os_user

string

OS user who was logged in when the event was acknowledged

5

acknowledge_iba_hdserver_user

string

ibaHD-Server user who was logged in when the event was acknowledged

6

acknowledge_iba_pda_user_user

string

ibaPDA user who was logged in when the event was acknowledged
Message "NumericField"

Pos.

Parameter

Data type

Meaning

1

name

string

Name of the field

2

value

double

Value of the field

3

isData

bool

Is TRUE if the current value is either true or false, and is FALSE if the current value is null.
Message "TextField"

Pos.

Parameter

Data type

Meaning

1

name

string

Name of the field

2

value

double

Value of the field

3

isData

bool

Is TRUE if the current value is either true or false, and is FALSE if the current value is null.
Enum "OrderByType"

The following values are available for OrderByType.

Value

Meaning

0

ORDER_BY_TYPE_UNSPECIFIED

Not specified

1

ORDER_BY_TYPE_DESCENDING

Descending order

2

ORDER_BY_TYPE_ASCENDING

Ascending order
Enum "EventTriggerType"

Value

Meaning

0

EVENT_TRIGGER_TYPE_UNSPECIFIED

Not specified

1

EVENT_TRIGGER_TYPE_INCOMING

Incoming event

2

EVENT_TRIGGER_TYPE_OUTGOING

Outgoing event
Enum "AckType"

Value

Meaning

0

ACK_TYPE_UNSPECIFIED

Not specified

1

ACK_TYPE_ACKNOWLEDGED

Status "acknowledged"

2

ACK_TYPE_NOT_ACKNOWLEDGED

Status "not acknowledged"

3

ACK_TYPE_PENDING

Status "pending"