Path Parameters
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:
- A single value that identifies a single object that can be identified by the path element.
- A single asterisk (*), identifying all objects that can be identified by the path element.
- A single asterisk followed by a plus sign (*+) followed by one or more key-value pairs ({key}{operator}{value}), each adjacent pair separated by an ampersand (&).
Path Parameter Descriptions
The following tables describe the path parameters that are available for the id, block, block_index, and datapoint_name path elements.
For DLA the valid path parameters for datapoint_name is defined on the DLA Files page.
{id} Path Parameters
The following list describes the optional path parameters for the device id path element used in Datapoint, Transformation, and Presets endpoints.
Path Parameter | Description |
assetTag | The asset tag. |
category | Specifies the category. Possible values:
|
connection | The connection status. |
connectionStatus | Same as the connection parameter. |
description | Description of the device. |
driver | The device driver name, such as LON, Modbus, BACnet, etc. |
firmwareVersion | The version number of the firmware. |
floor.name | Name of the floor where the device is located. |
floorplan.name | Name of floorplan or building where the device is located. |
geozone.description | The geozone description. |
geozone.id | The geozone ID. |
geozone.name | The geozone name. |
groups.id | ID of the group that the device belongs to. |
groups.name | Name of the group that the device belongs to. |
health | The health of the device. Supported values:
|
id | The device ID. |
installationDate | The device installation date. |
mac | Same as the uid parameter. |
name | The device name. |
programID | Program ID. |
protocol | Same as the driver parameter. |
provision | Same as the status parameter. |
scId | ID of the edge server where the device is connected. For Example: “17q4cdx” |
scName | Name of the edge server where the device is connected. |
status | The device's status. Supported values:
|
sts | Same as the status parameter. |
tag | Name of the tag assigned to the device. |
tag.name | Same as the tag parameter. |
tag.value | Value of the tag assigned to the device. |
tags | Same as the tag parameter. |
tags.name | Same as the tag parameter. |
tags.value | Same as the tag.value parameter. |
timezone | The device's timezone. |
type | Same as the programID parameter. |
typeName | The device's device type. |
uid | The device's unique ID. |
zone.name | Name of the zone, room, or floor where the device is located. |
{block} Path Parameter
The following list describes the optional path parameters for the block path element used in Datapoint, Transformation, and Presets endpoints.
| Path Parameter | Description |
type | Filters for blocks with the specified block type (profile). |
{block_index} Path Parameter
The following list describes the optional path parameters for the block_index path element used in Datapoint, Transformation, and Presets endpoints.
| Path Parameter | Description |
index | Filters for block_indexes with the specified block index. |
{datapoint_name} Path Parameters
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 |