GET /info
This resource returns all the basic information about the REST API. You can find 5 low resources: BACnet, device, extensions, network, supported services.
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.
Object Name: Info
| propertyName | type | description | get |
|---|---|---|---|
| Bacnet | Object | This object represent certain information concerning the BACnet device. | GET |
| Device | Object | This contains all the information about the device. | GET |
| ApiRevision | String | This is the last revision version of the API. | GET |
| ExtensionManagement | Object | This object represents the extensions management, actions and representations. | GET |
| Network | Object | This object is a representation of the network information. | GET |
| SupportedServices | Array |
This object is an comprises an array of all the services supported by the device. | GET |
Url Example: https://1.1.1.1/api/rest/v1/info
{
"device": {
"href": "/api/rest/v1/info/device",
"name": "device"
},
"apiRevision": "1.0",
"bacnet": {
"href": "/api/rest/v1/info/bacnet",
"name": "bacnet"
},
"extensionManagement": {
"href": "/api/rest/v1/info/extension-management",
"name": "extensionManagement"
},
"supportedServices": {
"href": "/api/rest/v1/info/supported-services",
"name": "supportedServices"
},
"network": {
"href": "/api/rest/v1/info/network",
"name": "network"
}
}
Url Example: https://1.1.1.1/api/rest/v1/info
<?xml version="1.0" encoding="utf-8"?>
<Info>
<ApiRevision>1.0</ApiRevision>
<Bacnet>
<Href>/api/rest/v1/info/bacnet</Href>
<Name>bacnet</Name>
</Bacnet>
<Device>
<Href>/api/rest/v1/info/device</Href>
<Name>device</Name>
</Device>
<ExtensionManagement>
<Href>/api/rest/v1/info/extension-management</Href>
<Name>extensionManagement</Name>
</ExtensionManagement>
<Network>
<Href>/api/rest/v1/info/network</Href>
<Name>network</Name>
</Network>
<SupportedServices>
<Href>/api/rest/v1/info/supported-services</Href>
<Name>supportedServices</Name>
</SupportedServices>
</Info>