GET /protocols/nlight/channels/{channelId}/object-types
FROM API REVISION 7.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 the nLight channel id. Correspond to the device resourceNumber
property.
Object Name: ObjectTypes
Property Name | Type | Description | Method |
---|---|---|---|
ObjectTypes | Array<ObjectType> | This is an array of ObjectType object. |
GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/channels/540/object-types
[
{
"href": "/api/rest/v1/protocols/nlight/channels/540/object-types/nLightChannelDimOutputLvl",
"name": "nLightChannelDimOutputLvl"
},
{
"href": "/api/rest/v1/protocols/nlight/channels/540/object-types/nLightChannelRelayState",
"name": "nLightChannelRelayState"
}
]
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/channels/540/object-types
<?xml version="1.0" encoding="utf-8"?>
<ObjectTypes>
<ObjectType>
<Href>
/api/rest/v1/protocols/nlight/channels/540/object-types/nLightChannelDimOutputLvl
</Href>
<Name>nLightChannelDimOutputLvl</Name>
</ObjectType>
<ObjectType>
<Href>
/api/rest/v1/protocols/nlight/channels/540/object-types/nLightChannelRelayState
</Href>
<Name>nLightChannelRelayState</Name>
</ObjectType>
</ObjectTypes>