/
Managing Datapoint Properties

Managing Datapoint Properties

By Nina Cardillo
10-Jan-2024

Datapoint properties describe attributes of a datapoint including a description, direction, property and read-only flags, and monitoring rate.  You can read or update these properties as indicated below.  For more information, refer to Datapoint Properties in the IAP/REST Reference.

Returns the specified properties of the specified datapoints. If no properties are specified, it returns all properties.


GET     /iap/devs/{device handle}/if/{block name}/{block index}/{datapoint name}/{datapoint property}


Updates the specified properties of the specified datapoints.


PUT     /iap/devs/{device handle}/if/{block name}/{block index}/{datapoint name}/{datapoint property}


Get_Set_Datapoint_Properties
GET    /iap/devs/17q2d9x.5/if/block/1/Volts_1/monitor
 
[
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Volts_1",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "monitor":{
            "cat":"data",
            "rate":0,
            "report":"change",
            "throttle":0,
            "inFeedback":true
        }
    }
]
 
 
 
PUT    /iap/devs/17q2d9x.5/if/block/1/Volts_1/values
Payload: {"cat":"data","rate":50,"report":"change","throttle":0,"inFeedback":true}
 
Success


API Method and Endpoints


Returns all datapoint properties for all devices

Get all datapoint properties 
GET    /iap/devs/*/if/*/*/*/*
 
[
    {
        "deviceId":"lon.sys",
        "blockName":"system",
        "blockIndex":"0",
        "datapointName":"service",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "interfaceType":"static",
        "default":"Device",
        "cat":"in",
        "property":true,
        "type":"8000010500008500-5/UCPTnetworkService",
        "value":"Device",
        "lon.cfg":{
            "tag":{
                 
            },
            "unit":"",
            "handle":1,
            "hidden":true,
            "length":1,
            "address":16382,
            "forward":{
                 
            },
            "pollRate":0,
            "persistent":true,
            "deviceSpecific":true
        },
        "desc":"service"
    },
    {
        "deviceId":"lon.sys",
        "blockName":"system",
        "blockIndex":"0",
        "datapointName":"mode",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "interfaceType":"static",
        "default":"Onnet",
        "cat":"in",
        "property":true,
        "type":"8000010500008500-5/UCPTnetworkMode",
        "value":"Onnet",
        "lon.cfg":{
            "tag":{
                 
            },
            "unit":"",
            "handle":0,
            "hidden":true,
            "length":1,
            "address":16383,
            "forward":{
                 
            },
            "pollRate":0,
            "persistent":true,
            "deviceSpecific":true
        },
        "desc":"mode"
    },
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Freq",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":0
            }
        },
        "cat":"out",
        "property":false,
        "monitor":{
            "cat":"data",
            "rate":0,
            "report":"change",
            "throttle":0,
            "inFeedback":true
        },
        "type":"0000000000000000-0/SNVT_freq_f",
        "value":0
    },
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Volts_1",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":-500
            }
        },
        "cat":"out",
        "property":false,
        "monitor":{
            "cat":"data",
            "rate":0,
            "report":"change",
            "throttle":0,
            "inFeedback":true
        },
        "type":"0000000000000000-0/SNVT_volt_f",
        "value":-500
    }
]


Return all properties for specific datapoint

Properties of Volts_1 datapoint
GET    /iap/devs/17q2d9x.5/if/block/1/Volts_1/*
 
[
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Volts_1",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":-500
            }
        },
        "cat":"out",
        "property":false,
        "monitor":{
            "cat":"data",
            "rate":0,
            "report":"change",
            "throttle":0,
            "inFeedback":true
        },
        "type":"0000000000000000-0/SNVT_volt_f",
        "value":-500
    }
]


Returns all datapoint "values" for device with handle 17q2d9x.5 and for block "block/1"

Return all datapoint of specific device
GET    /iap/devs/17q2d9x.5/if/block/1/*/values
 
[
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Freq",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":0
            }
        }
    },
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Volts_1",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":-500
            }
        }
    }
]


Returns properties for all datapoint which name starts with specific prefix "Volts"

Collect datapoint with specific prefix
GET    /iap/devs/17q2d9x.5/if/block/1/*+name=+^Volts/*
 
[
    {
        "deviceId":"17q2d9x.5",
        "blockName":"block",
        "blockIndex":"1",
        "datapointName":"Volts_1",
        "deviceState":"provisioned",
        "deviceHealth":"normal",
        "values":{
            "level":17,
            "levels":{
                "17":-500
            }
        },
        "cat":"out",
        "property":false,
        "monitor":{
            "cat":"data",
            "rate":0,
            "report":"change",
            "throttle":0,
            "inFeedback":true
        },
        "type":"0000000000000000-0/SNVT_volt_f",
        "value":-500
    }
]







































Related content