GET /protocols/m-bus/devices

FROM API REVISION 6.0
This will list all the discovered devices.
Once a device is discovered, it is saved into a "Cache".
This cache will contain only the discovered devices.

¶ Resource Information:

• URL: https://{deviceIP}/api/rest/v1/protocols/m-bus/devices
• Support Query Parameter? YES
• Requires Authentication? YES

¶ Parameters

¶ encode (optional)

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:

• json
• xml
• text
• bin

All these resources can be used according what the resource allows.

• Located in : Query
• Example values : encode=json

¶ $expand (optional) The$expand system query option specifies the related resources to be included in line with retrieved resources.

The value passed in the parameter can be:

• "\*" (star): This will expand all child elements.
• Choose a specific value: This will expand only the selected values.
• Choose multiple values: This will expand all selected values. The values must be separated by a "," (comma).

The $expand system query option can be used with the$levels query option, to expand recursively.

• Located in : Query
• Example values : GET api/rest/v1/info?$expand=device ¶ accept (optional) If this parameter is not in the request, the Application/Json will be chosen by default. There are multiple possible values (according the resource): • Application/Json • Application/Xml • Application/Octet-stream • Text/Plain The first two are the most often used. • Located in : Header • Example values : accept:application/json ¶$levels (optional)

Cyclic navigation properties can be recursively expanded using the special $levels option. This query option is used in addition to the$expand query options.
The value of the \$levels option is a positive integer to specify the number of levels to expand.

• Located in : Query
• Example values : GET api/rest/v1/info?$expand=extensionManagement($levels=2)

¶ Object(s) Representation

Object Name: Devices

Property Name Type Description Method
Devices Array<Device> This is the list of M-Bus devices discovered. GET

¶ Example Body Response

¶Application/Json


[
{
"href": "/api/rest/v1/protocols/m-bus/devices/116878982826457",
"name": "116878982826457"
},
{
"href": "/api/rest/v1/protocols/m-bus/devices/116878982826515",
"name": "116878982826515"
},
{
"href": "/api/rest/v1/protocols/m-bus/devices/116878982826772",
"name": "116878982826772"
}
]



¶Application/Xml


<?xml version="1.0" encoding="utf-8"?>
<Devices>
<Device>
<Href>/api/rest/v1/protocols/m-bus/devices/116878982826457</Href>
<Name>116878982826457</Name>
</Device>
<Device>
<Href>/api/rest/v1/protocols/m-bus/devices/116878982826515</Href>
<Name>116878982826515</Name>
</Device>
<Device>
<Href>/api/rest/v1/protocols/m-bus/devices/116878982826772</Href>
<Name>116878982826772</Name>
</Device>
</Devices>