...
where $ 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 field visibility settings, for example:
Code Block |
---|
{ "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lsid": "1", "lsn": "1", "uid": "1", "un": "1", "hn": "1", "lco": "1","lus": "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 XLSX 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": ""${un | hn | fns | fv | ftype | lsn | lco}",
"value": "${value}"
}
] |
To filter by a numeric column, use the following format:
Code Block |
---|
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid | 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, lsid, lsn, uid, un, hn, lco, lus
(See this section for more field-specific information.)
Response
The following code block shows an example result of a successful request.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"fid": ${featureId},
"fns": ${featureName},
"ftype": ${featureType},
"fv": ${featureVersion},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"uid": ${userId},
"un": ${userName},
"hn": ${hostName},
"lco": ${licenseCheckedOut},
"lus": ${licensesUsed}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
...
Standard format option. See Making an API request page for details. | |||
standard report options | No | various | Refer to Making an API request page for details. |
Response
On success, this report will contain one row for each license session. Each row consists of the following columns.
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
uid | User Id | integer | Internal License Statistics identification of user that checked out licenses. | Yes |
un | Username | string | Name of user that checked out licenses. | Yes |
hn | Hostname | string | Host on which licenses were checked out. | Yes |
fid | Feature Id | integer | Internal License Statistics identification of the used feature. | Yes |
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 |
lus | Used |
...
un
string
Username.
hn
string
Hostname.
lco
string
Date when license was checked out. The date is in YYYY-MM-DD HH:MM:SS format; for example; 2017-05-20 10:55:15.
integer | Total number of licenses used by user on host. |
msg
string
Error message returned on failure.
success
boolean
Indicates whether your API request was successfully processed.
Error code for unsuccessful request.
Yes | ||||
lco | Checked Out | date and time | Time when licenses were checked out. | Yes |
lsid | License Server Id | integer | Internal License Statistics identification of server hosting the used feature. | Yes |
lsn | License Server | string | Name of server hosting the used feature. | Yes |
Note that the order in the table is the default order of the columns in the exported file.
Obtaining information about current license usage
...
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/report/users/license/current-usage/json |
This report supports only JSON format.
This report does not support standard options (filtering, limiting or ordering)You can filter your data results using the filter parameter, as described above.
Response
The following code block shows an example result of a successful requestOn success, the license server will return the following response.
Code Block | ||
---|---|---|
| ||
{ "success": ${success}true, "msg": ${message}null, "data": [ { "hu": 1, "tu": ${usersWithLicensesCount} "current": ${current}, { "hu": 0, "tu"licenseUsage": ${usersWithoutLicensesCount} } ]licenseUsage}, "codelicenseLimit": ${codelicensedUsers}, "totalCount": 2} } |
where the response fields can be explained as follows.
Field | Type | Description |
---|
current |
Error code if success equals false, null otherwise.
Example
Say you have many license servers, some of which are LM-X servers called 'lm-x 1', 'lm-x 2', etc. The following example shows a command that lets you identify how many users are using licenses from those particular servers.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --globoff -H "X-Auth-token: token" 'http://yourdomain/api/v1/report/users/license/current-usage/json?filter=[{"type":"string","field":"lsn","value":"lm-x"}]' |
integer | Number of users or user-hosts that are currently using any license on any currently monitored license server. | |
licenseUsage | integer | Number of users or user-hosts that are counted for license usage. This value depends on the licensing model. |
licenseLimit | integer | Number of users or users-hosts that this license server is licensed for. |
Obtaining information about highest license usage
You can easily list the 10 users that are using the highest number of licenses by sending the following HTTP request.
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/report/users/license/highest-usage/json |
You can filter your data results using the filter parameter, as described above.
Response
The following code block shows an example result of a successful request.
Code Block | ||
---|---|---|
| ||
{
"success": ${success},
"msg": ${message},
"data": [
{
"un": ${userName},
"lus": ${usersWithLicensesCount}
}
],
"code": ${code},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
...
...
...
...
Error code if success equals false, null otherwise.
...
Example
The following example shows a command that lets you obtain information about users that have the highest usage of a feature named "super_feature" (in any version).
...
language | js |
---|---|
firstline | 1 |
linenumbers | true |
...
This report supports only JSON format.
This report does not support standard options (filtering, limiting or ordering).
Response
On success, this report will contain up to 10 rows of information about users with the highest number of checked out licenses. Each row consists of the following columns.
Field | Full name | Type | Description |
---|---|---|---|
un | Username | string | User name. |
lus | Used | integer | Number of all licenses used by the user. |