GET /protocols/nlight/channels
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.
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).
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 query parameter is used to requests only specific channels by their uniqueID.
They should be comma separated.
Object Name: NLightChannels
| Property Name | Type | Description | Method |
|---|---|---|---|
| NLightChannels | empty | This is an array of NLightChannel. It will contains all the existing channels. |
GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/channels
[
{
"href": "/api/rest/v1/protocols/nlight/channels/540",
"name": "540"
},
{
"href": "/api/rest/v1/protocols/nlight/channels/542",
"name": "542"
},
{
"href": "/api/rest/v1/protocols/nlight/channels/492",
"name": "492"
},
{
"href": "/api/rest/v1/protocols/nlight/channels/541",
"name": "541"
},
{
"href": "/api/rest/v1/protocols/nlight/channels/508",
"name": "508"
}
]
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/channels
<?xml version="1.0" encoding="utf-8"?>
<NLightChannels>
<NLightChannel>
<Href>/api/rest/v1/protocols/nlight/channels/540</Href>
<Name>540</Name>
</NLightChannel>
<NLightChannel>
<Href>/api/rest/v1/protocols/nlight/channels/542</Href>
<Name>542</Name>
</NLightChannel>
<NLightChannel>
<Href>/api/rest/v1/protocols/nlight/channels/492</Href>
<Name>492</Name>
</NLightChannel>
<NLightChannel>
<Href>/api/rest/v1/protocols/nlight/channels/541</Href>
<Name>541</Name>
</NLightChannel>
<NLightChannel>
<Href>/api/rest/v1/protocols/nlight/channels/508</Href>
<Name>508</Name>
</NLightChannel>
</NLightChannels>