Warning |
---|
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer. |
Obtaining a feature list
You can easily list To list all the features recognizable by License Statistics , use one of by sending the following HTTP request:.
Code Block |
---|
|
GET /api/v1/feature/${returnType} |
There is also another, already deprecated, endpoint that you can use:
Code Block |
---|
|
GET /api/v1/report/feature/${returnType} |
where the possible parameters are as follows: Anchor |
---|
feature list def | feature list defwhere $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are described below.Parameter | Required | Type | Description |
---|
${returnType} | Yes | string |
Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | fns | No | string | Applies quick filtering on a feature name. |
fv | No | string | Applies quick filtering on a feature version. |
ftype | No | string | Applies quick filtering on a feature type. |
lsn | No | string | Applies quick filtering on a license server name. |
vn | No | string | Applies quick filtering on a license server vendor name. |
gtn | No | string | Applies quick filtering on a license server gathering type. |
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format: Code Block |
---|
language | js |
---|
firstline | 1 |
---|
linenumbers | true |
---|
| [{"type": "${string | numeric}", "value": stringOrNumericValue, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}] |
|
limit | No | integer | Specifies the number of records that must be returned. The value must be greater than zero. |
offset | No | integer | Specifies the offset of the first row to return. |
orderBy | No | string | Specifies the field by which you want to order your data records. The field name can be one of the following: fid,fns, fv, ftype, lsid, lsn, vn, gtn. |
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
Note: By default, filter rules are case-insensitive.
Response
The response you get may be similar to the following:
Code Block |
---|
language | js |
---|
firstline | 1 |
---|
linenumbers | true |
---|
|
{
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:
Response
On success, report will contain one row for each feature recognizable by License Statistics. Each row consists of columns:
Column | Full name | Type | Description | Visible by default in export |
---|
fid | Feature ID | integer | Internal License Statistics identification of the feature. | No |
fns | Feature Name | string | Feature name. | Yes |
ftype | Feature Type | enumeration
| See feature type descriptions for details.
| Yes |
fv | Feature Version |
Field | Type | Description |
---|
fid | integer | Feature Id. |
fns | string | Feature name. |
fvftypeYes |
string | Feature type (Floating, Nodelocked or Token). | lsid server IdStatistics identification of license server hosting the feature.
| No |
lsn |
boolean 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. |
string
| Name of license server hosting the feature. | Yes |
vn | Vendor | string | Vendor of license server hosting the feature. | Yes |
gtn | Gathering | enumeration | Gathering type of license server hosting the feature. See gathering type descriptions for further details.
| Yes |
Note that the order in the table is the default order of the columns in the exported file.
Examples Examples
The following examples make use of the GET method.
Example 1
The following example shows a command that gets - 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" |
Example 2
The following example shows a command that obtains - To obtain feature information, filtered by name , and version and type, enter the following command:output to CSV format.
Code Block |
---|
|
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fn\", \"value\"=\"abc\"}, "fns=a&fv=2.1&ftype=floating" {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/jsoncsv" |
Example 3
The following example shows a command that gets information about a feature with an ID of "1."- To get feature information filtered by Id, enter the following command:
Code Block |
---|
|
curl --data-urlencode "filter=[{\"type\"=\"valuenumeric\": 1, \"field\": \"fid, \"field\"=\"fid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |