Versions Compared

Old Version 1

changes.mady.by.user Nina Cardillo

Saved on

compared with

New Version Current

changes.mady.by.user Nina Cardillo

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Obtains the present value of a datapoint. The present value conforms to the type specification for the datapoint. You can read/write to one or more datapoints at a time. There are many ways to do a bulk read or bulk writes to multiple datapoints, some of which are listed below.

...

Method          

URI and Fields

GET


/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/value/{prop_name}

Gets the current value for the specified datapoint.

See examples below.

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

The following list describes the optional path parameters for the prop_name path element of the Datapoint Value endpoint:

Path Parameter                                                        

Description

type={prop_type}Filters for properties with the specified property type.
value={prop_value}Filters for properties with the specified property value.


PUT/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/value/{prop_name}

Updates the default value for the specified datapoint, and will not be published until all overrides are cleared.

See examples below.

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

The following list describes the optional path parameters for the prop_name path element of the Datapoint Value endpoint:

Path Parameter                                                        

Description

type={prop_type}Filters for properties with the specified property type.
value={prop_value}Filters for properties with the specified property value.


...

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

Examples

Get all datapoints named nviValue:

...

Writing to a datapoint using device name and preset value, without specifying priority (sent at Normal (17) priority).

PUT      /iap/dp/*+*name==PulseGen1/if/device/0/nviHVACMode/presets/value         

Payload: ON


Writing to a datapoint using device name and preset value, specifying Normal (17) priority.

PUT      /iap/devs/*+*name==PulseGen1/if/device/0/nviHVACMode/overrides/17/presets/value         

Payload: ON

...

Writing to a structured datapoint using device name and preset value, without specifying priority (sent at Normal (17) priority).

PUT     /iap/dp/*+*name==PulseGen1/if/device/0/nviSwitch/localization/value         

Payload: {"state":1, "value":100}


Writing to a structured datapoint using device name and preset value, specifying Normal (17) priority.

PUT     /iap/devs/*+*name==PulseGen1/if/device/0/nviSwitch/overrides/17/localization/value         

Payload: {"state":1, "value":100}

...

Writing to datapoint using device name and preset value, without specifying priority (sent at Normal (17) priority).

PUT     /iap/devs/*+*name==PulseGen1/if/device/0/nviTemp/value         

Payload: 30


Writing to datapoint using device name and preset value, specifying Normal (17) priority.

PUT     /iap/devs/*+*name==PulseGen1/if/device/0/nviTemp/overrides/17/value         

Payload: 22

...

  • Sending Fahrenheit value: 95

    PUT     /iap/devs/*+*name==PulseGen1/if/device/0/nviCount/overrides/14/localization/value         

    Payload: 95


...

  • Sending Celsius value: 35

    PUT     /iap/devs/*+*name==PulseGen1/if/device/0/nviCount/overrides/14/localization/value         

    Payload: 35


...