Page History

...

Applies filtering license usage data on all fields.

To filter by a string column, use the following format:

Parameter

Required

Type

Description

${licenseServerId}

Yes

integer/string

Specifies ID of Internal License Statistics identification of the license server for which we 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 the format in which the data should be returned. The format can be one of the following: json, csv, xlsx, or 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 XLSX. 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 XLSX types. If provided, it cannot be left empty.

filter

No

json/string

Code Block

linenumbers	true

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

To filter by a numeric column, use the following format:

Code Block

linenumbers	true

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

limitNointegerDetermines the maximum number of data records that can be returned. The value must be greater than zero.offsetNointegerSpecifies the offset of the first row to return.orderByNostring

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.)

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

Response

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}
}

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	Username	string	Name of user that borrowed licenses.	Yes
hn	Hostname	string	Name of host where licenses are borrowed to.	Yes
uil	User is from LDAP

...

Field

Type

Description

lsidintegerLicense Server ID.lsnstringLicense Server name.fidintegerFeature ID.fnsstringFeature Name.ftypestringFeature type.fvstringFeature 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.

uidintegerUser 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 your API request was successfully processed.

codeinteger

Error code for unsuccessful request.

totalCountintegerTotal 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 about currently borrowed licenses on all servers, in CSV format.

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 18

New Version 19

Key

Example