Page History

The License Server Current Usage endpoint delivers license usage metrics specific to the License Server Current Usage, allowing you to monitor all the features for the currently selected license server.

...

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

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

...

...

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 and the . The possible parameters can be explained as followsare described below.

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

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

[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${ fu | fbrwd | frvd | ft | futil}",
        "value": "${value}"
    }
]

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

The following code block shows an example result of a successful request.

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

...

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	Feature Expires

string

date	Feature expiration date

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

.	Yes
flu	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

flu

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

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

Example 1

Say you want to download data in XLS format The following example shows a command that downloads data about current usage for license server "7". To generate this data set, enter a command similar to the following. in XLSX format.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/7/current-usage/xlsxlsx"

Example 2

If you want to obtain The following example shows a command that obtains information about features with current usage higher than 90% for license server "13.", enter the following command.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/13/current-usage/json" --data-urlencode 'filters=[{"type":"numeric","comparison":"gt","field":"futil","value":"90"}]'

Example 3

Let's assume you want to download data in a CSV file The following example shows a command that downloads data about current usage for license server group "1". To generate this data set, enter a command similar to the following in CSV format.

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