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 Usage endpoint delivers current license usage metrics, as detailed below.
Anchor | above24 | above24 | |
---|---|---|---|
Anchor | |||
|
...
Code Block | ||
---|---|---|
| ||
GET /api/v1/report/current-usage/on-multiple-hosts/${returnType}?(parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and . The possible parameters can be explained as followsare described below.
Parameter | Required | Type | Description |
---|---|---|---|
${returnType} | Yes | string |
Specifies field visibility settings, for example:
Code Block | ||||
---|---|---|---|---|
| ||||
{"un": "1", "hl": "1", "fns": "1", "fv":"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 license usage data on all fields.
To filter by a string column, use the following format.
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"type": "string",
"field": "${ fns | fv | ftype | vn | lsn | un | hl }",
"value": "${value}"
}
] |
Code Block | ||||
---|---|---|---|---|
| ||||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${ fid, lsid, uid }",
"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, fv, ftype, vn, lsid, lsn, uid, un, hl
(See this section for more field-specific information.)
The following code block shows an example result of a successful request.
Code Block | ||||
---|---|---|---|---|
| ||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"vn": ${vendorName},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hl": ${hostList},
"uil": ${hasUserLdapDetails}
}],
"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-user pair, where user has checked out licenses of feature on multiple hosts. 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. | No |
fns | Feature Name | string | Name of feature. | Yes |
fv | Feature Version | string | Feature version. | Yes |
ftype | Feature Type | enumeration | See feature type descriptions for details. | Yes |
vn | Vendor | string | Name of license server vendor hosting the feature. | Yes |
lsid | License Server Id | integer | Internal identification of license server hosting the feature. | No |
lsn | License Server | string | Name of license server hosting the feature. | Yes |
uid | User Id | integer | Internal License Statistics identification of the user. | No |
un | User | string | User name. | Yes |
hl | Hosts | string | List of hosts on which the user has checked out licenses of the feature, |
...
Field | Type | Description | |
---|---|---|---|
fid | integer | Feature ID. | |
fns | string | Feature name. | |
fv | string | Feature version. | |
ftype | string | Feature type. | |
vn | string | License server vendor name. | |
lsid | integer | License server ID. | |
lsn | string | License server name. | |
uid | integer | User ID. | |
un | string | Username. | |
hl | string | List of hostnames separated by a semicolon (;). | Yes |
uil | User is from LDAP | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
msg | string | Error message returned on failure. | |
success | boolean | Indicates wheher your API request was successfully processed. |
Example
Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Example
The following example shows a command that obtains Say you would like to obtain information about users using features on multiple hosts. 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-usage/on-multiple-hosts/json" |
Anchor | ||||
---|---|---|---|---|
|
Obtaining information about usage above/below
...
n hours (report Current Usage
...
By Time Range)
You can easily list data about features currently in use for more/less than N n hours by sending the following HTTP request
Code Block | ||
---|---|---|
| ||
GET /api/v1/report/current-usage/aboveby-ntime-hoursrange/${returnType}?ab=${hoursAboveinteger}&bl=${hoursBelowinteger}&(additional parameters, as needed) |
where $ indicates a variable value that you can replace with a value that best suits your needs and . The possible parameters can be explained as follows: are described below.
Parameter | Required | Type | Description | |||||||
---|---|---|---|---|---|---|---|---|---|---|
${returnType} | Yes | stringSpecifies | the format in which the data should be returned. The format can be one of the following: json, csv, xls, xslx or pdfStandard format option. See Making an API request for details. | |||||||
ab | No | integer | Specifies the minimum Minimum number of hours a license has to be used to be listed. If not provided is defaults to value "-1" which is equivalent of no constraintconstraint not imposed. | |||||||
bl | No | integer | Specifies the maximum Maximum number of hours a license can has to be used to be listed. If not provided is defaults to value "-1" which is equivalent of no constraint, this constraint is not imposed. Value must be greater than value of 'ab' parameter (does not apply for "-1" values). | |||||||
fieldsVisibilitystandard report options | No 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. | |||||||
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 | fv | ftype | vn | lsn | un | hn}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block | ||
---|---|---|
| ||
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid | uid | lus}",
"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, fv, ftype, vn, lsid, lsn, uid, un, hn, lus, tu
(See this section for more field-specific information.)
The following code block shows an example result of a successful request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"vn": ${vendorName},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hn": ${hostName},
"lus": ${licensesUsed},
"tu": ${timeUsed},
"uil": ${ldapUser},
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
various | See Making an API request for details. |
Response
On success, this report will contain one row for each license session, with length within specified range. Each row consists of the following columns.
...
vn
un
string
Username.
hn
string
Hostname.
lus
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
fid | Feature ID | integer | Internal License Statistics identification of the used feature. | No |
fns | Feature Name | string | Name of the used feature. | Yes |
fv | Feature Version | string | Version of the used feature. | Yes |
ftype | Feature Type | enumeration | Type of the used feature. See feature type descriptions for further details. | Yes |
vn | Vendor | string | Name license server vendor hosting the used feature. | Yes |
lsid | License Server Id | integer | Internal License Statistics identification of license server hosting the used feature. | No |
lsn | License Server | string | Name of license server hosting the used feature. | Yes |
uid | User Id | integer | Internal License Statistics identification of user that checked out licenses. | No |
un | User | string | Name of user that checked out licenses. | Yes |
hn | Host | string | Host on which licenses were checked out. | Yes |
lus | Used |
integer | Total number of licenses used by user on host. | Yes | |
tu | Time Used | string | Indicates how long |
licenses have been in use |
; e.g., 1d 2h 10 min. Note that you cannot filter on this field. | Yes | ||
uil | User is from LDAP | boolean | Indicates whether user details have been imported from an LDAP directory. Note that you cannot filter and order data by this field. |
msg
string
Error message returned on failure.
success
boolean
Indicates whether your API request was successfully processed.
Error code for unsuccessful request.
Total number of all matching results.
Unavailable |
Note that the order in the table is the default order of the columns in the exported file.
Example
The following example shows a command that downloads data in CSV format
ExampleSay you would like to download data in a CSV file about features currently in use for at least 24 hours. 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-usage/aboveby-ntime-hoursrange/csv?ab=24" |