Page tree
Skip to end of metadata
Go to start of metadata

The Current Utilization endpoint delivers license usage metrics specific to the Current Utilization report.

Obtaining information about current feature utilization

You can easily fetch metrics about current feature usage for a given feature by sending the following HTTP request.

GET /api/v1/report/current-utilization/${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
${returnType}YesstringStandard format option. See Making an API request for details.
standard report optionsNovarious

See Making an API request for details.

Response

On success, this report will contain one row for each feature or feature composite (cumulative feature in license server group), that currently is used on any license server. 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 or feature composite.

Yes

fns

Feature Name

string

Name of the feature or feature composite.

Yes

ft

Total

integer/string

Total amount of licenses for feature or sum of totals of all features in composite.

May be "Unknown" or "Unlimited."

Yes

ftype

Feature Type

enumeration

Type of the feature or feature composite. See feature type descriptions for further details.

Yes

fu

Used

integer

Amount of used licenses for feature or cumulative amount of used licenses for feature composite.

Yes

futil

Utilization

decimal

Percentage of used licenses (used/total).

Yes
fvFeature Versionstring

Version of the feature or feature composite.

Yes

ig

Is Group

boolean

True if row represents feature composite, false for single feature. For information about groups, see License server groups.

Yes
lsidLicense Server IDinteger

Internal License Statistics identification of:

  • for feature, license server hosting the feature.
  • for feature composite, license server group of the composite.
Yes
lsnLicense ServerstringName of license server or license server group. Yes
vnVendorstringVendor of license server or license server group. Yes

Example

The following example shows a command that downloads the current utilization report in CSV format.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/current-utilization/csv"
  • No labels