Returns the last occurrence for all requested events within the specified time range.
Message "GetLastEventOccurrenceRequest"
|
Pos. |
Parameter |
Data type |
Meaning |
|---|---|---|---|
|
1 |
time_range_from |
int64 |
Unix time stamp in microseconds that specifies how far in the past to search for the last occurrence of the event Leave 0 for the maximum range. |
|
2 |
time_range_to |
int64 |
Unix time stamp in microseconds, returns the last event that occurred before this time stamp To retrieve the last event that was ever recorded, set "time_range_to" to a date in the future or an int64 max value. |
|
3 |
channel_ids |
string |
List of event channel IDs in the format Example: |
|
4 |
acknowledgements |
bool |
Query optional details about the acknowledgment of events by the user |
|
5 |
numeric_fields |
string |
Query optional numeric fields in the response message for each event that contains the specified fields |
|
6 |
text_fields |
string |
Query optional text fields in the response message for each event that contains the specified fields |
Message "GetLastEventOccurrenceResponse"
Returns a single event or message Event for each requested event channel with the following parameters.
If no event was found for a specific channel, the response does not contain any data for this event channel.
|
Pos. |
Parameter |
Data type |
Meaning |
|---|---|---|---|
|
1 |
channel_id |
string |
Fully qualified ID in the format Example: |
|
2 |
timestamp |
int64 |
Unix time stamp 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 "EventTriggerType". |
|
6 |
event_acknowledgement |
- |
Optional information for the acknowledgment 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 "EventTriggerType"
|
Value |
Meaning |
|
|---|---|---|
|
1 |
EVENT_TRIGGER_TYPE_UNSPECIFIED |
Not specified |
|
2 |
EVENT_TRIGGER_TYPE_INCOMING |
Incoming event |
|
3 |
EVENT_TRIGGER_TYPE_OUTGOING |
Outgoing event |