POST /protocols/bacnet/local/objects/read-property-multiple
Read multiple points in one request. This reduces
the amount of network traffic required to transmit data.
This resource supports three Content-types:
In the Body request, you need to specify the encoding attributes (asn or text).
If you want to view all instances of one specific type use instance="-1".
If you want to view all properties of one specific object use property="all".
Both attributes can be combined.
All fields are <span class="small-warning">required except the arrayIndex.
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.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: ReadPropertyMultiple
| Property Name | Type | Description | Method |
|---|---|---|---|
| encode | String | This property is used to indicate which type is needed to recover the values, or the type you are writing the values from/in the device :
|
POST |
| PropertyReferences | Array <PropertyReference> |
This object is an array of PropertyReference object. | POST |
Object Name: PropertyReference
| Property Name | Type | Description | Method |
|---|---|---|---|
| Type required |
String | This property is the name of the object type. | POST |
| Instance required |
Integer | This property is the object's instance. | POST |
| Property required |
String | This property is the object's property name | POST |
| ArrayIndex optional |
Integer | This property is the index used to read a table property value. Use -1 if there is no array index. |
POST |
| Message | String | This property refers to the property value recovered. | POST |
| Value required |
String | This property is used during a write property multiple to write the value. | POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
{
"encode": "asn",
"propertyReferences": [
{
"type": "analogValue",
"instance": 1,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 2,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 95959,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 4,
"property": "objectName",
"arrayIndex": -1
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
asn
analogValue¤1,2,3¤objectName,presentValue,priorityArray
binaryValue¤-1¤objectName
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
<?xml version="1.0" encoding="utf-8"?>
<PropertyReferences encode="asn">
<PropertyReference type="analogValue" instance="1" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="2" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="95959" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="4" property="objectName" arrayIndex="-1" />
</PropertyReferences>
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
{
"encode": "asn",
"propertyReferences": [
{
"type": "analogValue",
"instance": 1,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 2,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 95959,
"property": "objectName",
"arrayIndex": -1
},
{
"type": "analogValue",
"instance": 4,
"property": "objectName",
"arrayIndex": -1
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
<?xml version="1.0" encoding="utf-8"?>
<PropertyReferences encode="asn">
<PropertyReference type="analogValue" instance="1" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="2" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="95959" property="objectName" arrayIndex="-1" />
<PropertyReference type="analogValue" instance="4" property="objectName" arrayIndex="-1" />
</PropertyReferences>
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/read-property-multiple
asn
analogValue¤1,2,3¤objectName,presentValue,priorityArray
binaryValue¤-1¤objectName