POST /protocols/bacnet/remote/devices/start-discovery
FROM API REVISION 6.0
This resource is used to start the discovery of the BACnet remote devices.
The properties DeviceInstanceRangeLowLimit
and DeviceInstanceRangeHighLimit
need to be send together, if one is send without the other, an error 400 Bad Request will be thrown.
The networkAddress
and timeout
value are required.
If they are not present an error 400 Bad Request will be thrown.
When the request succeed, a job ID will be in the response that will allow you to follow the progress. See the jobs api for more details.
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: StartDiscovery
Property Name | Type | Description | Method |
---|---|---|---|
JobId | String | This is the ID of the jobs where you can follow the process, or cancel the discovery. |
Object Name: Discovery
Property Name | Type | Description | Method |
---|---|---|---|
DeviceInstanceRangeLowLimit optional |
Integer | This is the lowest limit for the BACnet remote device instance range. This property is required if the DeviceInstanceRangeHighLimit is sent. |
POST |
DeviceInstanceRangeHighLimit optional |
Integer | This is the Highest limit for the BACnet remote device instance range. This property is required if the DeviceInstanceRangeLowLimit is sent. |
POST |
NetworkAddress required |
Integer | This is the network address. | POST |
Timeout required |
Integer | This is the maximum time allowed for discovery. This property has to be set in millisecond. Example (for 10 seconds): 10000 Min : 10000ms Max : 120000ms |
POST |
ClearCache optional |
Boolean | This property is used to clear cached values. Only the devices discovered during this request will be available. Default value : false. |
POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
{
"deviceInstanceRangeLowLimit": 0,
"deviceInstanceRangeHighLimit": 60000,
"networkAddress": 1,
"timeout": 10000
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
{
"deviceInstanceRangeLowLimit": 0,
"deviceInstanceRangeHighLimit": 60000,
"networkAddress": 1,
"timeout": 10000
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<DeviceInstanceRangeLowLimit>0</DeviceInstanceRangeLowLimit>
<DeviceInstanceRangeHighLimit>60000</DeviceInstanceRangeHighLimit>
<NetworkAddress>1</NetworkAddress>
<Timeout>10000 </Timeout>
</Discovery>
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<DeviceInstanceRangeLowLimit>0</DeviceInstanceRangeLowLimit>
<DeviceInstanceRangeHighLimit>60000</DeviceInstanceRangeHighLimit>
<NetworkAddress>1</NetworkAddress>
<Timeout>10000 </Timeout>
</Discovery>
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
{
"deviceInstanceRangeLowLimit": 0,
"deviceInstanceRangeHighLimit": 60000,
"networkAddress": 1,
"timeout": 10000
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<DeviceInstanceRangeLowLimit>0</DeviceInstanceRangeLowLimit>
<DeviceInstanceRangeHighLimit>60000</DeviceInstanceRangeHighLimit>
<NetworkAddress>1</NetworkAddress>
<Timeout>10000 </Timeout>
</Discovery>