Versions Compared

Old Version 2

changes.mady.by.user Łukasz Ćwikła

Saved on

compared with

New Version 3

changes.mady.by.user Unknown User (mkos)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

License Statistics API allows you to generate data about license server current usagefrom the License Server Current Usage page, which shows general information about the license server and its features.

Obtaining information about license server or license server group current usage

If you want to retrieve information about current usage of a single license server, we recommend that you use the following URL request template.

Code Block
languagejs
linenumberstrue
GET /api/v1/report/license-server/${lsid}/current-usage/${returnType}

If you want to To retrieve the information for a license server group, use the following oneURL.

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

...

ParameterRequiredTypeDescription
${lsid}YesintegerLicense Server ID.
${lsgid}YesintegerLicense Server Group ID.
${returnType}YesstringSpecifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf.
fieldsVisibilityNojson/string

Specifies field visibility settings, for example:

Code Block
languagejs
firstline1
linenumberstrue
{
  "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 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.
filterNojson/string

Applies filtering license usage data on all fields.

To filter by string column, use the following format:

Code Block
languagejs
firstline1
linenumberstrue
[
	{ 
		"type": "string",
		"field": "${ fns | fv | ftype | fexp | flu }",
		"value": "${value}"
	}
]

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

 

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "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.
orderByNostringSpecifies 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.
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

...

where the response fields can be explained as follows: 

FieldTypeDescription
fidintegerFeature ID.
fnsstringFeature name.
fvstringFeature version.
ftypestringFeature type.
fuintegerNumber of used licenses.
fbrwdintegerNumber of borrowed licenses.
frvdintegerNumber of reserved licenses reservations or string "N/A" string if License Reservations are not supported by the license server.
ftintegerFeature total or string Total licenses for a feature or "Unlimited" if sostring in case of unlimited license.
futilintegerFeature Percentage of feature utilization in percent.
fexpstringFeature expiration date in format YYYY-MM-DD format.

flu

stringFeature last update time in format YYYY-MM-DD hh:mm:ss format.

fiexp

booleanWhether Indicates whether the feature is has expired.

msg

stringError message returned on failure.

success

booleanIndicates if whether the API request was successfully processed. 
codeintegerError code for unsuccessful request.
totalCountintegerTotal number of rows.

 

...

Note: Data returned for 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

 

To download Say you want to download statistics about current usage for license server 7 as an XSL file. To generate such data, enter a command similar to the following:

Code Block
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/license-server/7/current-usage/xsl"

Example 2

To get features of license server 13 which have If you want to obtain information features with current usage higher than 90% for license server 13, enter a command similar to the following command:

Code Block
linenumberstrue
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

To download Let's assume you want to download statistics about current usage for license server group 1 as an CSV filein CSV format. To generate such data, enter a command similar to the following:

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