A path parameter can be included in any item reference field for the path component. The item reference fields are the id, block, block_index, datapoint_name, and prop_name values in paths such as:
/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/value [/{prop_name}] /iap/devTypes/{device_type}/if/{{block}/{block_index}/{datapoint_name}/dla /iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/presets |
Path parameters can be specified in the following forms:
...
The following list describes the optional path parameters for for the block path element used in Datapoint, Transformation, and Presets endpoints.
...
The following list describes the optional path path parameters for the block_index path element used in Datapoint, Transformation, and Presets endpoints.
...
The following list describes the optional path parameters for the device datapoint_name path element used in Datapoint, Transformation, and Presets endpoints.
( For DLA the valid path parameters for datapoint_name is defined on the DLA Files page).
| Path Parameter | Description |
dpName | The datapoint instance name |
groups.id | ID of the group that the datapoint belongs to |
groups.name | Name of the group that the datapoint belongs to |
local | The arrival timestamp (e. g. 2017-08-23T11:34:22.123+01:00) |
lvl_1_interval | Log interval 1. |
lvl_1_retention | Log retention period 1. |
lvl_2_interval | Log interval 2. |
lvl_2_retention | Log retention period 2. |
lvl_3_interval | Log interval 3. |
lvl_3_retention | Log retention period 3. |
mru | Same as local parameter |
MRU | Same as local parameter |
name | Same as dpName parameter |
property | Indicates whether the datapoint is a property (true) or non-property (false). Possible values:
|
qualifier | The full datapoint qualified name, such as {SID}/{driver}/{DID}/{block_XIF_name}/{block_index}/{datapoint_XIF_name} Example: 17q4cdx/iap/1.meter/phase/0/nvoVoltageRMS |
status | The datapoint status. The status value can be online or offline. |
tag | Filters for datapoints with the specified tag name. |
tag.value | Filters for datapoints with the specified tag value. |
tags | Same as tags parameter |
timestamp | Same as local parameter |
timestampZone | The time zone, such as UTC, BST, etc. |
type | The datapoint type name |
utc | Same as local parameter |
xifName | The datapoint XIF name |
...