POST /protocols/m-bus/devices/{mbusDeviceId}/points/start-discovery
FROM API REVISION 6.0
Used to start a M-Bus device points discovery.
This request has to be sent to find the existing M-Bus device points.
If the discovery is already started, an error 409 Conflict is returned.
If a value is invalid an error 422 Unprocessable Entity is returned.
This resource return a Job ID, used to follow the progression of the discovery.
See [Jobs](http://eclypseapi.distech-controls.com/restApi/jobs "Jobs documentation") for more details.
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.
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 id of a M-bus 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 |
---|---|---|---|
AppResetSubCode | This property has to be sent for the points discovery. | ||
Allowed values : |
|
POST |
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/116878982826457/points/start-discovery
{
"appResetSubCode": 0
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/116878982826457/points/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<AppResetSubCode>0</AppResetSubCode>
</Discovery>
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/116878982826457/points/start-discovery
{
"appResetSubCode": 0
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/m-bus/devices/116878982826457/points/start-discovery
<?xml version="1.0" encoding="utf-8"?>
<Discovery>
<AppResetSubCode>0</AppResetSubCode>
</Discovery>