| 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
To You can easily list features recognizable by License Statistics , use by sending the following HTTP request:.
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/feature/${returnType} |
where the $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows: described below.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string |
Specifies field visibility settings, for example:
| Code Block | ||
|---|---|---|
| ||
{ "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lsid": "1", "lsn": "1", "vn": "1", "gtn": "1"} |
where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.
If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty.
Applies filtering to narrow down the results.
To filter by a string column, use the following format:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${fns | fv | ftype | lsn | vn | gtn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
| Code Block | ||
|---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid}",
"value": "${value}"
}
] |
Response
The response you get may be similar to the following:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"success": ${success},
"msg": ${message},
"data": [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"vn": ${licenseServerVendorName},
"gtn": ${licenseServerGatheringType}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
...
Error message returned on failure.
...
Error code for unsuccessful request.
| Standard format option. See Making an API request for details. | |||
| standard report options | No | various | See Making an API request for details. |
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 | string | Feature version. | Yes |
| lsid | License Server ID | integer | Internal License Statistics identification of license server hosting the feature. | No |
| lsn | License Server | 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
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/feature/json" |
Example 2
The following example shows a command that obtains - To obtain feature information, filtered by name and version , enter the following command: and output to CSV format.
| Code Block | ||||
|---|---|---|---|---|
| ||||
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fn\", \"value\"=\"abc\"}, {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"}]"
-H "X-Auth-token: token" "http://yourdomain/api/v1/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\"=\"numeric\", \"field\"=\"fid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/feature/json" |
...
There is also another, already deprecated, endpoint that you can use:
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/feature/${returnType} |
...
Applies filtering license usage data on all fields. To filter your data, use the following format:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[{"type": "${string | numeric}", "value": stringOrNumericValue, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}] |
...
Note: By default, filter rules are case-insensitive.
...