GET /protocols/nlight/profiles
FROM API REVISION 4.0
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 $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.
Object Name: NLightProfiles
Property Name | Type | Description | Method |
---|---|---|---|
NLightProfiles | Array<NLightProfile> | This is an array of NLightProfiles . It will contains all the existing profiles. |
GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/profiles
[
{
"href": "/api/rest/v1/protocols/nlight/profiles/1",
"name": "1"
}
]
URL Example: https://0.0.0.0/api/rest/v1/protocols/nlight/profiles
<?xml version="1.0" encoding="utf-8"?>
<NLightProfiles>
<NLightProfile>
<Href>/api/rest/v1/protocols/nlight/profiles/1</Href>
<Name>1</Name>
</NLightProfile>
</NLightProfiles>