POST /protocols/bacnet/remote/devices/{remoteDeviceId}/objects/start-discovery
FROM API REVISION 6.0
This resource is used to discover the objects of a BACnet remote device.
If the device is offline you will receive an error 409 Conflict.
When the request succeed you will get a Job ID to follow the discovery 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.
This is the instance number of the device.
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 |
|---|---|---|---|
| ForceUpdate optional |
Boolean | Default value : false | POST |
| AliveTimeout required |
Integer | This property is used to check if a device is online. This is the maximum time we will wait until the device respond. This property has to be set in millisecond. Example (5 sec) : 5000 Default value (1 sec) : 1000 |
POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/start-discovery
{
"forceUpdate": true,
"aliveTimeout": 1000
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<ForceUpdate>true</ForceUpdate>
<AliveTimeout>1000</AliveTimeout>
</Discovery>
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/start-discovery
{
"forceUpdate": true,
"aliveTimeout": 1000
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/remote/devices/83218/objects/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<ForceUpdate>true</ForceUpdate>
<AliveTimeout>1000</AliveTimeout>
</Discovery>