GET /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/{objectType}/{objectInstance}/properties/{propertyName}/
FROM API REVISION 6.0
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
* (star) : This will show all child elements., (comma).If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
This is the object type string value.
This is the instance of a specific BACnet object type.
This is the name of the property.
This is the instance number of the device.
Object Name: BacnetProperty
| Property Name | Type | Description | Method |
|---|---|---|---|
| Name | String | This property is the name of the BACnet property. | GET |
| IsArray | Boolean | This property indicates if the BACnet property is an array or not. | GET |
| Implementation | String | GET | |
| AsnValue | String | This property is the ASN value of a BACnet property encoded in Base64. | GET |
| Value required |
empty | This property is the readable value of a BACnet property. According the BACnet property, it's possible the type of this property vary. (See the description of the resource for more details) | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/device/83218/properties/description
{
"value": "The description value",
"asnValue": "cQA=",
"isArray": false,
"implementation": "",
"name": "description"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/device/83218/properties/description
<?xml version="1.0" encoding="utf-8"?>
<BacnetProperty>
<Name>description</Name>
<IsArray>false</IsArray>
<Implementation />
<AsnValue>cQA=</AsnValue>
<Value>The description value</Value>
</BacnetProperty>