...
Note: By default, filter rules are case-insensitive.
Response
The response you get may be similar to the following:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: true,
msg: ${message},
data: [{
fid: ${featureId},
fns: ${featureName},
fv: ${featureVersion},
ftype: ${featureType},
lsid: ${licenseServerId},
lsn: ${licenseServerName},
vn: ${licenseServerVendorName},
gtn: ${licenseServerGatheringType}
}]
} |
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| fid | integer | Feature Id. |
| fns | string | Feature name. |
| fv | string | Feature version. |
| ftype | string | Feature type (Floating, Nodelocked or Token). |
| lsid | integer | License server Id. |
| lsn | boolean | License server name. |
| success | boolean | This field indicates that the API request was successfully processed. |
| vn | string | License server vendor name. |
| gtn | string | Gathering type (imported, realtime). |
| msg | string | Unlimited string. |
Examples
The following examples make use of GET method.
- To get the list of all License Statistics features, type the following from a command line:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
- To obtain feature information filtered by name, version and type, enter the following command:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data "fns=a&fv=2.1&ftype=floating" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
...
- To get feature information filtered by Id, enter the following command:
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"value\": 1, \"field\": \"fid\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
Deprecated endpoint
There is also another, already deprecated, endpoint that you can use:
...
Note: By default, filter rules are case-insensitive.
The response is fields are exactly the same as for above in case of the first endpoint.