/api/metadata/property [POST]
Usage
Creates a new property, or returns the ID of an existing property if one already exists.
Details
Detail | Value |
---|---|
Group | Asset |
From Server Version | 0.9.0 |
Permission | Admin |
Methods | POST |
Parameters
Parameter | Notes | Meaning |
---|---|---|
name | String [Required] | The name of the new property] |
type | String [Required] | The type of the new property] |
options | String (None) | Any options that apply to the new property] |
id | Integer] | The ID of the existing property (if updating)] |
format | String (xml) | Either 'xml' or 'json' |
Examples
Call
[POST] http://ardiserver.com/api/asset/property?name=Temperature&type=measurement&default=%7C0%7C100%7C1%7CDeg%20C
Note that in the above URL, the 'default' parameter is encoded
The option being saved is default=25|0|100|1|Deg C, meaning that the default value for the property should be 25 degrees C, ranged between 0-100 and with 1 decimal place.
Success (XML)
<?xml version="1.0" encoding="UTF-8" standalone="no"?> <success> <message>Property Created</message> <id>23</id> </success>
Success (JSON)
[{ "message": ["Already Exists"], "id": ["31"] }]