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. |
The Current Utilization endpoint delivers license usage metrics specific to the Current Utilization report.
Obtaining information about current feature utilization
...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
Parameter | Required | Type | Description | |||
---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls, xslx or pdf. | |||
fieldsVisibility | No | json/string | Specifies field visibility settings, for example:
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. It works with every 'returnType' other than 'json'. | |||
rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. For CSV and JSON formats this parameter will be ignored. If you don't pass this parameter, it will be generated automatically for PDF and XLS types. If provided, it cannot be left empty. | filter | No | json/string |
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[
{
"type": "string",
"field": "${fns | ftype | fv | lsn | vn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | ft | fu | futil | ig | lsid}",
"value": "${value}"
}
] |
Specifies the field by which you want to order your data records. The field name can be one of the following:
fid, fns, ft, ftype, fu, futil, fv, ig, lsid, lsn, vn
The following code block shows an example result of a successful request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"ft": ${featureTotal},
"ftype": ${featureType},
"fu": ${licensesUsed},
"futil": ${featureUtilization},
"fv": ${featureVersion},
"ig": ${isGrouped},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"vn": ${vendorName}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
...
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, this report will contain one row for each feature or feature composite (cumulative feature in license server group), that currently is used on any license server. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
fid | Feature ID | integer | Internal License Statistics identification of the feature or feature composite. | Yes |
fns | Feature Name | string | Name of the feature or feature composite. | Yes |
ft | Total | integer/string | Total amount of licenses for feature or sum of totals of all features in composite. May be "Unknown" or "Unlimited." | Yes |
ftype | Feature Type | enumeration | Type of the feature or feature composite. See feature type descriptions for further details. | Yes |
fu | Used | integer | Amount of used licenses for feature or cumulative amount of used licenses for feature composite. | Yes |
futil | Utilization |
...
fid
integer
Feature ID
fns
string
Feature name.
ft
integer
Total amount of licenses.
ftype
string
Type of feature
fu
integer
Amount of used licenses
decimal | Percentage of used licenses (used/total). | Yes | ||
fv | Feature Version | string | Version of the feature or feature composite. | Yes |
ig | Is Group |
integer
boolean | True if row represents feature composite, false for single feature. |
For information about groups |
, see License server groups. | Yes | ||
lsid | License Server ID | integer | Internal License |
msg
string
Error message returned on failure.
success
boolean
Indicates whether your API request was successfully processed.
Error code for an unsuccessful request.
Total number of all matching results.
Example
Statistics identification of:
| Yes | |||
lsn | License Server | string | Name of license server or license server group. | Yes |
vn | Vendor | string | Vendor of license server or license server group. | Yes |
Example
The following example shows a command that downloads the current utilization report in CSV formatSay you would like to download this report in csv format . To generate this data set, enter a command similar to the following.
Code Block | ||
---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-utilization/csv" |
...