system.historian.queryValues
This function is used in Python Scripting.
Description​
Queries values for the specified Historian.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax #1​
system.historian.queryValues(definitions, filter)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| list | definitions | A list of historical definitions to query values for. |
| Dictionary[String, Any] | filter | Filters to include/exclude value data within the returned query results, such as quality and timestamp. |
Returns​
Dataset - A dataset representing the historian values for the specified historical paths.
Scope​
Gateway, Vision Client, Perspective Session
Syntax #2​
system.historian.queryValues(paths, startDate[, endDate][, columnNames][, returnFormat][, limitMode][, limit][, aggregates][, fillModes][, includeBounds][, includeObservations])
Parameters​
| Type | Parameter | Description |
|---|---|---|
| List | paths | A list of historical paths to query values for. |
| Date | startDate | A start time to query values for. |
| Date | endDate | An end time to query values for. [optional] |
| List | columnNames | A list of alias column names for the returned dataset. [optional] |
| String | returnFormat | The desired return format for the query. [optional] |
| String | limitMode | The limit mode to apply to the query. [optional] |
| Integer | limit | The maximum number of results to return. [optional] |
| List | aggregates | A list of aggregate functions to apply to the query. [optional] |
| List | fillModes | A list of fill modes to apply to the query. [optional] |
| Boolean | includeBounds | Whether to include the bounds in the query results. [optional] |
| Boolean | includeObservations | Whether to include observed values in the query results. [optional] |
Returns​
Dataset - A dataset representing the historian values for the specified historical paths.
Scope​
Gateway, Vision Client, Perspective Session