Page History

...

You can easily fetch metrics about current usage for a single license serverby sending one of the following HTTP requestrequests.

Code Block

language	js
title	Current usage for a single license server

GET /api/v1/report/license-server/${lsid}/current-usage/${returnType}

...

Code Block

language	js
title	Current usage for a license server group

...

Code Block

language	js

GET /api/v1/report/license-server-group/${lsgid}/current-usage/${returnType}

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
${lsid}	Yes	integer

License Server ID

Internal License Statistics identification of license server to show usage on.
${lsgid}	Yes	integer

License Server Group ID

Internal License Statistics identification of license server group to show usage on.
${returnType}	Yes	string

Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xlsx, or pdf.fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block

language	js
firstline	1
linenumbers	true

{
  "fid": "1",
  "fns": "1",
  "fv": "1",
  "ftype": "1",
  "fu": "1",
  "fbrwd": "1",
  "frvd": "1",
  "ft": "1",
  "futil": "1",
  "fexp": "1",
  "flu": "1"
}

where "1" indicates that a specific field is visible and ''0" indicates it is not.

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

NostringSpecifies 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.filterNojson/string

Applies filtering license usage data on all fields.

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

Code Block

language	js
firstline	1
linenumbers	true

[
	{ 
		"type": "string",
		"field": "${ fns | fv | ftype | fexp | flu }",
		"value": "${value}"
	}
]

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

Code Block

language	js
firstline	1
linenumbers	true

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${ fu | fbrwd | frvd | ft | futil}",
        "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:

fid, fns, fv, ftype, fu, fbrwd, frvd, ft, futil, fexp, flu

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

orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or 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: [{
        "fid": "${featureId}",
        "fns": "${featureName}",
        "fv": "${featureVersion}",
        "ftype": "${featureType}",
        "fu": "${licensesUsed}",
        "fbrwd": "${licensesBorrowed}",
        "frvd": "${licensesReservations}",
        "ft": "${total}",
        "futil": "${licenseUtilization}",
        "fexp": "${expireDate}",
        "flu": "${lastUsageUpdateDate}",
        "fiexp": "${isExpired}"
    }],
    "code": ${errorCode},
    "totalCount": ${totalNumberOfRecords}
}

...

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 hosted on the license server, or one of the license server groups, that currently has checked out licenses. 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	Feature name.	Yes
fv	Feature Version	string	Feature version.	Yes
ftype	Feature Type	enumeration	See feature type descriptions for details.	Yes
fu	Used

...

FieldTypeDescriptionfidintegerFeature ID.fnsstringFeature name.fvstringFeature version.ftypestringFeature type.fu

	integer	Number of used licenses.	Yes
fbrwd	Borrowed	integer	Number of borrowed licenses.	Yes
frvd	Reserved	integer/string	Number of reserved licenses, or "N/A"

string

if License Reservations are not supported by the license server.	Yes
ft	Total	integer/string	Total licenses for a feature or "Unlimited"

string in case of

if an unlimited license.	Yes
futil	Utilization	integer	Percentage of feature utilization.	Yes
fexp

string

Feature Expires

date

Feature expiration date

in YYYY-MM-DD format; for example 2017-05-20.

fiexp

.	Yes
flu

stringFeature last update time in YYYY-MM-DD hh:mm:ss format; for example 2017-05-20 10:15:45.

Last Update	date and time	Time of last update. For realtime, the time the feature was last seen on the license server.	Yes
fiexp	Expired

boolean

Indicates whether the feature has expired.

msg

stringError message returned on failure.

success

booleanIndicates whether your API request was successfully processed. codeintegerError code for unsuccessful request.totalCountintegerTotal rows.

No

Note that the order in the table is the default order of the columns in the exported file.

Note: Data returned for a license server group consists of a summary of all features of all license servers in the group, including hidden ones. (See License server groups for more information.)

...

Code Block

linenumbers	true

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server-group/131/current-usage/csv"

Page tree

Versions Compared

Old Version 11

New Version 12

Key