GET /system/licenses/{licenseID}/
This resource is used to read all the details about a specific license, mainly the validity and features.
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 $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 id of the file.
Object Name: License
| Property Name | Type | Description | Method |
|---|---|---|---|
| HostId | String | This is a unique un-alterable identifier for this controller. | GET |
| Generated | String | This is the date when the license was generated. | GET |
| Valid | Boolean | True if the license is valid ; False otherwise. The license can be invalid if the signature don't match, the file is corrupted or is not created for this specific controller. | GET |
| Features | Array<Feature> | This is an array of Feature. It contains all the the feature that the license allow. | GET |
URL Example: https://0.0.0.0/api/rest/v1/system/licenses/1
{
"features": {
"href": "/api/rest/v1/system/licenses/1/features",
"name": "features"
},
"valid": true,
"hostId": "ECYS1000-CCCCCCCC-9999-8888-7777-AAAAAAAAAAAA",
"generated": "2018-06-28"
}
URL Example: https://0.0.0.0/api/rest/v1/system/licenses/1
<?xml version="1.0" encoding="utf-8"?>
<License>
<Features>
<Href>/api/rest/v1/system/licenses/1/features</Href>
<Name>features</Name>
</Features>
<HostId>ECYS1000-CCCCCCCC-9999-8888-7777-AAAAAAAAAAAA</HostId>
<Generated>2018-06-28</Generated>
<Valid>true</Valid>
</License>