EAPI
Contents
Methods
The following methods can be called via the local bus (see EAPI commons):
Citem.state_history
Description |
Get item state history (cursor), prepares data as Apache Arrow IPC stream |
Parameters |
required |
Returns |
BUS/RT cursor (u=cursor UUID) |
Name |
Type |
Description |
Required |
oid_map |
OID processing maps (list) |
Maps for server-side OID processing |
yes |
fill |
String |
Fill (nS/T/H/D/W e.g. 10T for 10-minute) + optional [:precision] |
yes |
t_start |
f64/String |
Beginning timestamp (default: last 24 hours) |
no |
t_end |
f64/String |
Ending timestamp (default: now) |
no |
limit |
u32 |
Limit records to |
no |
time_format |
String |
Time format: raw (UNIX TIMESTAMP, default), rfc3399 or no (no time colum required) |
no |
N
Description |
Get a next record of the cursor |
Parameters |
required |
Returns |
Next record if available |
Name |
Type |
Description |
Required |
u |
UUID |
BUS/RT cursor UUID |
yes |
NB
Description |
Get next records of the cursor in bulk |
Parameters |
required |
Returns |
Array of next records if available |
Name |
Type |
Description |
Required |
u |
UUID |
BUS/RT cursor UUID |
yes |
c |
u32 |
Max number of records |
no |
Payloads
The following complex structures are used:
OID processing map
The map is used to process EVA ICS item OIDs on the server side:
Name |
Type |
Description |
Required |
oid |
String |
Item OID |
yes |
status |
bool/String |
Include (and assign a name) item status |
no |
value |
bool/String |
Include (and assign a name) item value |
no |
database |
String |
Get the item state history from a custom db service |
no |
xopts |
Map<String, Any> |
Extra database query options |
no |