This is an old revision of the document!
/api/asset/set
Usage
This function is used to set the value of an asset property.
Many properties have more than one 'node' (sub-value), such as measurements, which have 'measurement', 'min', 'max', 'units' and 'places'. You can choose to set a specific value by setting the node parameter.
If you don't include a node parameter, you'll set the default node. This is the number in a measurement, state in a status, value in an enum etc and will usually be the most common way to call this function.
If you pass a blank node parameter, you'll be able to write the combined value. This is a bar (|) delimited combination of the various node values. For example, to set a measurement property all at once, you could write 12|0|100| Deg C|1, which means…
1) The current amount is 12.0
2) The minimum is 0
3) The maximum is 100
4) The units are Deg C (with a space between the number and the units)
5) It will normally show 1 decimal point
Details
| Detail | Value |
|---|---|
| Group | Asset |
| From Server Version | 0.9.0 |
| Permission | Guest |
| Methods | GET or POST |
Parameters
| Parameter | Notes | Meaning |
|---|---|---|
| id | Number [Required] | The ID of the asset |
| format | String (xml) | Either 'xml' or 'json' |
| value | String [Required] | The value to write |
| node | String [Optional] | The node name to write to |
Examples
Call
http://ardiserver.com/api/asset/set?id=5&property=10&value=22.5
This sets the value of property 10 on asset 5 to 22.5.
Call
http://ardiserver.com/api/asset/set?id=5&property=10&value= Deg F&node=units
This changes the units of measurement on property 10 on asset 5 to 'Degrees F'.
http://ardiserver.com/api/asset/set?id=5&property=10&value=15|0|100|Deg C|1&node=
This changes the property to a value of 15, range of 0-100, units in Deg C and showing 1 decimal place.