Datapoint Overrides
- Nina Cardillo
Up to 17 overrides can be specified for any datapoint. Each override has a priority and value, where the priority is a value between 1 and 17, and the value is a datapoint value conforming to the type specification for the datapoint, or the value is *null* if an override is not active for the level.
Priority 1 is the highest priority, and priority 17 is the lowest. The highest active priority (i.e. active state and non-null value) override value is sent to a datapoint when the highest priority active override value is changed, or a higher priority override value is made active. If no override values are active, the default value is sent to the datapoint. The array of 17 override values is called the priority array.
To set and update Override states and values, refer to Datapoint Override State and Datapoint Override Value.
See also Normal Value, for information on overrides and normal values.
URI Definition
Method | URI and Fields |
GET | /iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/overrides |
Returns the priority array with priorities and override values for the specified datapoints. If multiple datapoints are specified, a separate priority array is returned for each. Any values that are not active are returned as null. The datapoint path element uses the datapoint instance name. The block path element uses the block XIFname. Query Parmeters
Success responseCollections with the priority array with priorities and override values for the specified datapoints. Exampleshttps://localhost/iap/devs/*/if/*/*/nvoEPpos/overrides
RESPONSE:
[
{
"deviceId": "17q3cve.3",
"blockName": "device",
"blockIndex": "0",
"dpName": "nvoEPpos",
"currentLevel": 17,
"prioritizedValues": [
{
"level": 1,
"value": null,
"state": "inactive"
},
{
"level": 2,
"value": null,
"state": "inactive"
},
{
"level": 3,
"value": null,
"state": "inactive"
},
{
"level": 4,
"value": null,
"state": "inactive"
},
{
"level": 5,
"value": null,
"state": "inactive"
},
{
"level": 6,
"value": null,
"state": "inactive"
},
{
"level": 7,
"value": null,
"state": "inactive"
},
{
"level": 8,
"value": null,
"state": "inactive"
},
{
"level": 9,
"value": null,
"state": "inactive"
},
{
"level": 10,
"value": null,
"state": "inactive"
},
{
"level": 11,
"value": null,
"state": "inactive"
},
{
"level": 12,
"value": null,
"state": "inactive"
},
{
"level": 13,
"value": null,
"state": "inactive"
},
{
"level": 14,
"value": null,
"state": "inactive"
},
{
"level": 15,
"value": null,
"state": "inactive"
},
{
"level": 16,
"value": null,
"state": "inactive"
},
{
"level": 17,
"value": 1933.7,
"state": "active"
}
]
}
]
|
Queries
You can include queries with your IAP/REST request to specify a selection rule for your request. As described in Queries and Parameters, you can specify a query as a query parameter appended to the end of your URI preceded with a "?" character, or as a path parameter within a path element of the path component.
The following list describes the optional path parameters for the devices id path element of the Datapoint Overrides endpoint:
Path Parameter | Description |
|---|---|
| assetTag={tag} | Filters the devices for the specified asset tag |
| category={cat} | Filters the devices for the specified category. The value for cat can be edge for edge devices, or sc for segment controllers (edge servers), such as the SmartServer IoT. |
| connection={conn} | Filters for devices with the specified connection status. |
| description={desc} | Filters the devices for the specified description. |
| firmwareVersion={version} | Filters for devices running the specified firmware version number. |
| geozone.description={gz_desc} | Filters the devices for the specified geozone description. |
| geozone.id={gz_id} | Filters for devices with the specified geozone ID. |
| geozone.name={gz_name} | Filters for devices with the specified geozone name. |
| health={health} | Filters for devices with the specified health. |
| id={dev_id} | Filters for devices with the specified device ID. |
| installation_date={date} | Filters for devices with the specified installation date. |
| name={device_name} | Filters for devices with the specified device name. |
| status={status} | Filters for devices with the specified status. The status values can be provisioned, unprovisioned, provisioning, unprovisioning, or deleted. |
| timezone={tz} | Filters for devices installed in the specified timezone. |
| type={device_type} | Filters for devices with the specified device type. |
| uid={uid} | Filters for devices with the specified unique ID. |
The following list describes the optional path parameters for the block_name path element of the Datapoint Overrides endpoint:
Path Parameter | Description |
|---|---|
| type={profile} | Filters for blocks with the specified block type (profile). |
The following list describes the optional path parameters for the datapoint_name path element of the Datapoint Overrides endpoint:
Path Parameter | Description |
|---|---|
| lvl_1_interval={log_interval_1} | Filters for datapoints with the specified log interval 1. |
| lvl_1_retention={log_retention_1} | Filters for datapoints with the specified log retention period 1. |
| lvl_2_interval={log_interval_2} | Filters for datapoints with the specified log interval 2. |
| lvl_2_retention={log_retention_2} | Filters for datapoints with the specified log retention period 2. |
| lvl_3_interval={log_interval_3} | Filters for datapoints with the specified log interval 3. |
| lvl_3_retention={log_retention_3} | Filters for datapoints with the specified log retention period 3. |
| status={sts} | Filters for datapoints with the specified status. The sts value can be online or offline. |
| tag={tag_name} | Filters for datapoints with the specified tag name. |
| tag.value={tag_value} | Filters for datapoints with the specified tag value. |
| type={dp_type} | Filters for datapoints with the specified datapoint type name. |