Values
Raw values can be fetched using the following endpoint.
GET /api/v1/values
Query Parameters
| Parameters | Description |
|---|---|
| from | ISO-8601 date string (for example 2021-03-02T09:11:11Z). |
| to | ISO-8601 date string (for example 2021-03-02T09:11:11Z). |
| nodeId | The node ID of the machine. |
| externalTagId | The external ID of the tag (multiple supported). |
| tagId | The ID of the tag (multiple supported, not used with externalTagId). |
| intervalOptions | Flags determining which values are requested, see below for details. |
| sampleRateStrategy | 1 = Detailed Data, 2 = Aggregated Data. |
IntervalOptions
| Flag | Value | Description |
|---|---|---|
| Previous | 1 | Latest known value before the specified time interval is included. |
| Inside | 2 | Values inside the specified time interval are included. |
| Next | 4 | The first known value after the specified time interval is included. |
The default is Previous | Inside (3).
Note: Previous can be used with an interval set in the future to fetch the latest known value.
SampleRateStrategy
When fetching a large number of values, the data can be aggregated into fewer values to reduce the payload size and improve performance. The sampleRateStrategy parameter determines how the data is returned:
| Value | Description |
|---|---|
| 1 | Detailed Data: Returns all available raw values within the specified time range. |
| 2 | Aggregated Data: Returns aggregated values (e.g., averages, min/max) based on the time range and sampling rate. |
If unspecified it's automatically set to Aggregated Data for timespans larger than a day.
Note: Use
Aggregated Datafor long time ranges or when detailed data is not required to optimize performance.
Single values can be written using the following endpoint.
POST /api/v1/values
Query Parameters
| Parameters | Description |
|---|---|
| nodeId | The node ID of the machine. |
| externalTagId | The external ID of the tag. |
| tagId | The ID of the tag (not used with externalTagId). |
| value | Tag value to be written (must match the tag type). |