GET /protocols/m-bus/devices/{mbusDeviceId}/points

FROM API REVISION 6.0
This will list all the discovered points.
Once a point is discovered, it is saved into a "Cache".
This cache will contain only the discovered points.\t

¶ Resource Information:

• URL: https://{deviceIP}/api/rest/v1/protocols/m-bus/devices/{mbusDeviceId}/points
• 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 ¶$orderby (optional)

The $orderby system query option allows clients to request collections in a particular order. The value passed in the parameter can be "asc" for ascending order and or "desc" for descending order. If you prefer, it is possible to order the elements according to a specific value (see the example). • Located in : Query • Example values : GET /api/rest/v1/info/network/adapters?$orderby=ipaddress

¶ 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.

• 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)

¶ mbusDeviceId

The id of a M-bus device.

• Located in : Path
• Example values : 22836392694777

¶ Object(s) Representation

Object Name: Points

Property Name Type Description Method
Points Array<Point> Array of M-Bus device point. GET

¶ Example Body Response

¶Application/Json


[
{
"href": "/api/rest/v1/protocols/m-bus/devices/116878982826457/points/0",
"name": "0"
},
{
"href": "/api/rest/v1/protocols/m-bus/devices/116878982826457/points/1",
"name": "1"
}
]



¶Application/Xml


<?xml version="1.0" encoding="utf-8"?>
<Points>
<Point>
<Href>/api/rest/v1/protocols/m-bus/devices/116878982826457/points/0</Href>
<Name>0</Name>
</Point>
<Point>
<Href>/api/rest/v1/protocols/m-bus/devices/116878982826457/points/1</Href>
<Name>1</Name>
</Point>
</Points>