Datapoint properties describe attributes of a datapoint including a description, direction, property and read-only flags, and monitoring rate.

URI Definition

Method

URI and Fields

GET

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/[{prop_name} | *]

Returns the specified properties of the specified datapoints. If no properties are specified using "*", it returns all properties. The properties are described in Datapoint Objects.

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 Properties 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}/{prop_name}

Updates the specified properties of the specified datapoints. The properties are described in Datapoint Objects.

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 Properties 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.

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.

Examples

The following APIs are for a datapoint within a submeter functional block implementing profile number 21.61:

/iap/devs/{id}/if/{block_type}/{block_handle}/cpMinSendTime/*

/iap/devs/{id}/if/{block_type}/{block_handle}/cpMaxSendTime/*

/iap/devs/{id}/if/{block_type}/{block_handle}/cpMaxRcvTime/*

/iap/devs/{id}/if/{block_type}/{block_handle}/cpSendOnDelta/*

/iap/devs/{id}/if/{block_type}/{block_handle}/cpDbhSwitchFB?8

Get all properties for a specific datapoint PulseGen1/device/0/nviCount

GET /iap/devs/*+name==PulseGen1/if/device/0/nviCount/*

RESPONSE:

[
{
"deviceId":2,
"deviceName":"PulseGen1",
"deviceHealth":"normal",
"deviceState":"provisioned",
"blockName":"device",
"blockIndex":0,
"utc":"2020-08-07T00:28:00.006Z[UTC]",
"local":"2020-08-06T17:28:00.006-07:00[America/Los_Angeles]",
"dpQualifier":"17qam88/lon/1/device/0/nviCount",
"datapointName":"nviCount",
"name":"nviCount",
"presetValue":null,
"locValue":18,
"cat":"in",
"desc":"",
"type":"SNVT_count",
"value":18,
"values":
{
"level":11,
"levels":
{
"11":18,
"14":45,
"17":45
}
},
"inactive":{}},
"default":null,
"lon.cfg":
{
"tag":{},
"unit":"units",
"handle":0,
"length":2,
"address":16383
,"forward":{},
"lastUpdate":"",
"persistent":false
},
"monitor":
{
"cat":"data"
,"rate":0,
"event":false,
"focus":null,
"health":"normal",
"report":"change",
"lon.cfg":
{
"propagationThrottle":0,
"propagationHeartbeat":0,
"propagationThreshold":0
},
""throttle":0,
""heartbeat":0,
""threshold":0,
""inFeedback":false,
""receiveTimeout":0
},
"presets":
{"map":[],"enabled":false
},
"property":false,
"localization":{},
"interfaceType":"static"
}
]

Note: values shows the override priorities and their value so "11":18 means Priority 11 has a value of 18