GET /protocols/nlight/devices/{nlightDeviceId}/object-types/{resourceType}/{objectInstance}/
FROM API REVISION 4.0
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.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
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.
This the nLight device id.
Correspond to the device resourceNumber
property.
This is the BACnet resource type name.
This is the BACnet object resourceType
property
This is the instance of the BACnet object.
Object Name: BacnetObject
Property Name | Type | Description | Method |
---|---|---|---|
ObjectType | String | This is the type name of the BACnet object. | GET |
ObjectInstance | Integer | This property is the instance of the BACnet object. | GET |
ResourceType | String | This is the type name of the Resource | GET |
ObjectName | String | This is the name of the BACnet object. | GET |
HexID | String | This is the device unique ID. | GET |
FilePath | String | This is the file path of the BACnet object XML file. | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/devices/12/object-types/nLightOccupied/101221
{
"hexID": "00773970",
"objectInstance": 101221,
"objectName": "Room2Occ1_OccupiedP1_00773970",
"objectType": "Binary Input",
"filePath": "/bacnet/configuration/nLight/nLightOccupied101221.xml",
"resourceType": "nLightOccupied"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/devices/12/object-types/nLightOccupied/101221
<?xml version="1.0" encoding="utf-8"?>
<BacnetObject>
<ResourceType>nLightOccupied</ResourceType>
<ObjectType>Binary Input</ObjectType>
<ObjectName>Room2Occ1_OccupiedP1_00773970</ObjectName>
<ObjectInstance>101221</ObjectInstance>
<HexID>00773970</HexID>
<FilePath>/bacnet/configuration/nLight/nLightOccupied101221.xml</FilePath>
</BacnetObject>
Object Name: BacnetObject
Property Name | Type | Description | Method |
---|---|---|---|
ObjectType | String | This is the type name of the BACnet object. | GET |
ObjectInstance | Integer | This property is the instance of the BACnet object. | GET |
ResourceType | String | This is the type name of the Resource | GET |
ObjectName | String | This is the name of the BACnet object. | GET |
HexID | String | This is the device unique ID. | GET |
FilePath | String | This is the file path of the BACnet object XML file. | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/devices/12/object-types/nLightOccupied/101221
{
"hexID": "00773970",
"objectInstance": 101221,
"objectName": "Room2Occ1_OccupiedP1_00773970",
"objectType": "Binary Input",
"filePath": "/bacnet/configuration/nLight/nLightOccupied101221.xml",
"resourceType": "nLightOccupied"
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/devices/12/object-types/nLightOccupied/101221
<?xml version="1.0" encoding="utf-8"?>
<BacnetObject>
<ResourceType>nLightOccupied</ResourceType>
<ObjectType>Binary Input</ObjectType>
<ObjectName>Room2Occ1_OccupiedP1_00773970</ObjectName>
<ObjectInstance>101221</ObjectInstance>
<HexID>00773970</HexID>
<FilePath>/bacnet/configuration/nLight/nLightOccupied101221.xml</FilePath>
</BacnetObject>