GET /protocols/nlight/profiles/{resourceNumber}/object-types/{resourceType}/
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.
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.
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:
The $expand system query option can be used with the $levels query option, to expand recursively.
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.
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.
This is the BACnet resource type name.
This is the BACnet object resourceType property
Profile resourceNumber property.
Object Name: ObjectType
| Property Name | Type | Description | Method |
|---|---|---|---|
| BacnetObjects | Array<BacnetObject> | This object is an array of BACnet Objects. It will contain all the instances of the specified type. | GET |
Object Name: BacnetObjects
| Property Name | Type | Description | Method |
|---|---|---|---|
| BacnetObjects | Array<BacnetObject> | This object is an array of BACnet Objects. It will contain all the instances of the specified type. | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/profiles/1/object-types/nLightProfileState
{
"bacnetObjects": [
{
"href": "/api/rest/v1/protocols/nlight/profiles/1/object-types/nLightProfileState/100170",
"name": "nLightProfileState_100170"
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/profiles/1/object-types/nLightProfileState
<?xml version="1.0" encoding="utf-8"?>
<ObjectType>
<BacnetObjects>
<BacnetObject>
<Href>/api/rest/v1/protocols/nlight/profiles/1/object-types/nLightProfileState/100170</Href>
<Name>nLightProfileState_100170</Name>
</BacnetObject>
</BacnetObjects>
</ObjectType>