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 Currently Borrowed Licenses endpoint delivers license usage metrics specific to the Currently Borrowed Licenses report, allowing you to monitor borrowed licenses for all servers or for a selected serverLicense Statistics API allows you to obtain information about Currently Borrowed Licenses report.
Obtaining information about borrowed licenses
To You can easily list licenses that are currently borrowed, usefollowing URL templatecurrently borrowed licenses by sending the following HTTP request.
Code Block |
---|
GET /api/v1/report/license-server/${licenseServerId}/borrowed-licenses/${returnType} |
where :- $ $ indicates a variable value that you can replace with a proper value, according to your needs- the value that best suits your needs. The possible parameters are as follows:described below.
Parameter | Required | Type | Description |
---|---|---|---|
${licenseServerId} | Yes | integer/string |
Internal License Statistics identification of |
the license server for which you want to gather data about currently borrowed licenses. You can set this parameter to 'all' to gather data from all license servers. | ||
${returnType} | Yes | string |
Specifies field visibility settings, for example:
Code Block |
---|
{ "lsid": "1", "lsn": "1", "fid": "1", "fns": "1", "fv": "1", "ftype": "1", "lus": "1", "lco": "1", "lbe": "1", "uid": "1", "un": "1", "hn": "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 string column, use the following format:
Code Block |
---|
[
{
"type": "string",
"field": ""${lsn | fns | fv | ftype | lco | lbe | un | hn}",
"value": "${value}"
}
] |
To filter by numeric column, use the following format:
Code Block |
---|
[
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${lsid | fid | lus | uid}",
"value": "${value}"
}
] |
Specifies the field by which you want to order your data records. The field name can be one of the following: lsid, lsn, fid, fns, fv, ftype, lus, lco, lbe, uid, un, hn.
If your request is successful, you should see a response similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{
success: ${success},
msg: ${message},
data: [{
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"lus": ${licensesUsed},
"lco": ${checkoutTime},
"lbe": ${borrowExpire},
"uid": ${userId},
"un": ${userName},
"hn": ${hostName},
"uil": ${ldapUser},
}],
"code": ${errorCode},
"totalCount": ${totalCount}
} |
where the response fields can be explained as follows:
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, the report will contain one row for each borrow on specified server or servers. Each row consists of the following columns:
Column | Full name | Type | Description | Visible by default in export |
---|---|---|---|---|
lsid | License Server ID | integer | Internal License Statistics identification of the server hosting the borrowed feature. | No |
lsn | License Server | string | Name of the server hosting the borrowed feature. | Yes |
fid | Feature ID | integer | Internal License Statistics identification of the borrowed feature. | No |
fns | Feature Name | string | Name of the borrowed feature. | Yes |
fv | Feature Version | string | Version of the borrowed feature. | Yes |
ftype | Feature Type | enumeration | Type of the borrowed feature. See feature type descriptions for further details. | Yes |
lus | Licenses used | integer | Total number of licenses borrowed by user on host. | Yes |
lco | Checked Time | date and time | Time when licenses were checked out. | Yes |
lbe | Borrow Expiration | date and time | Time when the borrow expires. | Yes |
uid | User ID | integer | Internal License Statistics identification of user that borrowed licenses. | No |
un | User | string | Name of user that borrowed licenses. | Yes |
hn | Host | string | Name of host where licenses are borrowed to. | Yes |
uil | User is from LDAP |
lus
integer
Total number of licenses used by user on host.
lco
string
Date when license was checked out, in 'YYYY-MM-DD HH:MM' format.
lbe
string
Borrow expiration date, in 'YYYY-MM-DD HH:MM' format.
un
string
Username.
hn
string
Hostname.
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 the API request was successfully processed.
Error code for unsuccessful request.
Total number of all matching results.
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 downloads data If you want to obtain information about currently borrowed licenses on all servers, in CSV format, enter a command similar to this one:.
Code Block | ||
---|---|---|
| ||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/all/borrowed-licenses/csv |
...