Datapoint Override Value

Owned by Nina Cardillo
10-Jan-2024

Specifies the value at a specified override priority for a datapoint. The override value must conform to the type specification for the datapoint. A scalar datapoint value can be specified as a single scalar value.

Overrides are provided through a priority array. Unlike traditional overrides, priority overrides support multiple levels of overrides for a single datapoint. There can be up to 16 overrides that are active at a time, with the value of the datapoint equal to the value of the highest priority value. These are also the same type of overrides that are defined by schedule events so that multiple schedule events defined for the same datapoint at the same time can be resolved through the same priority mechanism.

Some devices implement a single override value configured into a device with an override value configuration property, and enabled through a command sent to the device Node object. Since these can be configured and enabled per device, they effectively become the highest priority override when used with the other two types of overrides.

IAP/MQ Mapping

For information on mapping these requests to IAP/MQ, see the Value field in the Datapoint Objects table.

URI Definition

Method

URI and Fields

GET


/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value

Returns the override value for the specified datapoints and priority levels. A null value is treated as inactive.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The level path element allows you to specify an override level. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

PUT


/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value

Sets the override value to the specified value for the specified datapoints and priority levels. For structured values, a subset of the fields may be specified.  Any fields that are not specified are preserved. The override state must be set to active to make the value active.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The level path element allows you to specify an override level. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value

Sets the override value to null for the specified datapoints and priority levels.

XIFname vs Instance Name

  • The block path element uses the block XIFname.
  • The datapoint_name path element uses the datapoint instance name.

Path Parameters

The level path element allows you to specify an override level. 

The optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.

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 optional path parameters for the id, block, block_index, and datapoint_name path elements are listed on the Path Parameters page.