Page History

License Statistics API allows you to obtain information about The Currently Borrowed Licenses endpoint delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch license usage metrics specific to the Currently Borrowed Licenses report, allowing you to monitor borrowed licenses for all servers or for a selected server.

Obtaining information about borrowed licenses

To list licenses that are If you want to fetch a list of currently borrowed licenses, usefollowing use the following URL request template.

Code Block

linenumbers	true

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 value that best suits your needs - and the possible parameters are as follows:

Parameter	Required	Type	Description
${licenseServerId}	Yes	integer/string

Id

ID of the license server

of interest, or string "all" to get information from all servers

for which you want to see borrowed licenses (or a string, if All is selected).
${returnType}	Yes	string	Specifies the format in which the data should be returned. The format can be one of the following:

json

JSON,

csv

CSV,

xls

XLS or

pdf

PDF.

fieldsVisibility

No

json/string

Specifies field visibility settings, for example:

Code Block

linenumbers	true

{ "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.

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

Applies filtering license usage data on all fields.

To filter by string column, use the following format:

Code Block

linenumbers

code

true

[
    {
        "type": "string",
        "field": ""${lsn | fns | fv | ftype | lco | lbe | un | hn}",
        "value": "${value}"
    }
]

To filter by numeric column, use the following format:

Code Block

linenumbers	true

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsid | fid | lus | uid}",
        "value": "${value}"
    }
]

limit

No

integer

Determines the maximum number of data records that can be returned. The value must be greater than zero.

offset

No

integer

Specifies the offset of the first row to return.

orderBy

No

string

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

(See this section for more field-specific information.)

orderDirection

No

string

Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order.

If your request is successful, you should see a response similar to the following: The following code block shows an example result of a successful request:

Code Block

language	js
firstline	1
linenumbers	true

{
    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:

Anchor

	fields def
	fields def

Field	Type	Description
lsid	integer	License Server ID.
lsn	string	License Server name.
fid	integer	Feature ID.
fns	string	Feature Name.
ftype	string	Feature type.
fv	string	Feature version.
lus	integer	Total number of licenses used by user on host.
lco	string	Date when license was checked out, . The date is in 'YYYY-MM-DD HH:MM' format; for example 2017-05-20 10:15.
lbe	string	Borrow expiration date. The date , is in 'YYYY-MM-DD HH:MM' format; for example, 2017-05-20 10:15.
uid	integer	User ID.
un	string	Username.
hn	string	Hostname.
uil	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 that your API request was successfully processed.
code	integer	Error code for unsuccessful request.
totalCount	integer	Total number of all matching results.

Example

...

Say you want to

...

see statistics for the currently borrowed licenses on all servers in CSV format. To fetch such statistics, enter a command similar to

...

the following:

Code Block

linenumbers	true

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/all/borrowed-licenses/csv

Page tree

Versions Compared

Old Version 2

New Version 3

Key

Obtaining information about borrowed licenses

Example