/api/asset/propvalue

Usage

Scans the ARDI database and returns a list of property values across all assets.

Rather than search every asset for a value, you can request properties from a list of assets using the asset parameter.

Note: This function doesn't return the latest live values from properties that are bound to live data. However, it does return the remote attribute, which provides the point ID needed to use the Live Data API and request either a subscription or a snapshot of live data.

Details

Detail	Value
Group	Asset
From Server Version	0.9.0
Permission	Guest
Methods	GET

Parameters

Parameter	Notes	Meaning
props	List [Required]	A comma-delimited list of property IDs
assets	List	A comma-delimited list of asset IDs - if left blank, all assets are searched.
format	String (xml)	Either 'xml' or 'json'

Examples

Call

http://ardiserver.com/api/asset/propvalue?props=3

Returns the address (property ID 3) of every asset that has one.

http://ardiserver.com/api/asset/propvalue?props=3,5,18&asset=4,5,6,7,8,9,10

Returns properties 3, 5 & 18 for all assets with IDs between 4 and 10.

Success (XML)

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<results>
  <property id="3" asset="5">
    <address>10/75 Cygnet Avenue, Shellharbour City Center, NSW, Australia</address>
  </property>
  <property id="21" asset="9">
    <measurement>-15</measurement>
    <units>RPM</units>
    <min>0</min>
    <max>2000</max>
    <places>0</places>
  </property>
  <property id="21" asset="10">
    <measurement>15</measurement>
    <units>RPM</units>
    <min>0</min>
    <max>2000</max>
    <places>0</places> 
  </property>
  <property id="21" asset="11">
    <measurement>15</measurement>
    <units>RPM</units>
    <min>0</min>
    <max>2000</max>
    <places>0</places>
  </property>
  <property id="21" asset="12">
    <measurement>15</measurement>
    <units>RPM</units>
    <min>0</min>
    <max>2000</max>
    <places>0</places>
    <remote>12:21:measurement</remote>
  </property>
</results>

Success (JSON)

[{
	"property": [{
		"id": "3",
		"asset": "5",
		"address": ["10\/75 Cygnet Avenue, Shellharbour City Center, NSW, Australia"]
	}, {
		"id": "21",
		"asset": "9",
		"measurement": ["-15"],
		"units": ["RPM"],
		"min": ["0"],
		"max": ["2000"],
		"places": ["0"]
	}, {
		"id": "21",
		"asset": "10",
		"measurement": ["15"],
		"units": ["RPM"],
		"min": ["0"],
		"max": ["2000"],
		"places": ["0"]
	}, {
		"id": "21",
		"asset": "11",
		"measurement": ["15"],
		"units": ["RPM"],
		"min": ["0"],
		"max": ["2000"],
		"places": ["0"]
	}, {
		"id": "21",
		"asset": "12",
		"measurement": ["15"],
		"units": ["RPM"],
		"min": ["0"],
		"max": ["2000"],
		"places": ["0"]
	}]
}]

/api/asset/propvalue