Versions Compared

Key

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


Warning
This page refers to functionality that has been removed from License Statistics. This information no longer applies to License Statistics v6.3 and newer.


EntityAPI Endpoints
FeatureFeature API
License ServerLicense Server API
License Server GroupLicense Server Group API

Most reports in License Statistics are based around specific core entities, listed below along with their relative API endpoints.

The API endpoints relative to License Statistics usage data are listed below.

License Statistics tabAPI Endpoints
License Server → Current UsageLicense Server Current Usage API
License Server → UptimeLicense Server Uptime API
License Server → Usage History

Usage History API (server)

Features → Current UsageCurrent Feature Usage API
Features → Usage HistoryUsage History API (feature)
Features → User History

User History API

Features → Utilization HistoryFeature Utilization History API
Features → DenialsDenials API
Reports → Current UsersCurrent Users API
Reports → Usage Per UserUsage Per User API
Reports → Usage History ComparisonUsage History API (features)
Reports → Current UtilizationCurrent Utilization API
Reports → Realtime Users Count

Realtime Users Count API

User Hosts List API

Reports → Expiring FeaturesExpiring Features API
Reports → Currently Borrowed LicensesCurrently Borrowed Licenses API
Reports → Current Usage By Time RangeCurrent Usage API (usage above/below N hours)
Reports → Current Usage On Multiple HostsCurrent Usage API (used on multiple hosts) 

To obtain information about the License Statistics features, use the following request:

Code Block
languagejs
firstline1
linenumberstrue
GET /api/report/feature/${returnType}

...

Applies filtering license usage data on all fields. To filter your data, use the following format:

Code Block
languagejs
firstline1
linenumberstrue
[{"value": intOrString, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}]

...

Note: By default, filter rules are case-insensitive.

Response

Code Block
languagejs
firstline1
linenumberstrue
{
success: true, 
message: ${message}, 
data: [{
  fid: ${featureId}, 
  fns: ${featureName},
  fv: ${featureVersion},
  ftype: ${featureType},
  lsid: ${licenseServerId},
  lsn: ${licenseServerName},
  vn: ${licenseServerVendorName},
  gtn: ${licenseServerGatheringType}
}]
}

where the response fields can be explained as follows:

FieldTypeDescription
fidintegerFeature Id.
fnsstringFeature name.
fvstringFeature version.
ftypestringFeature type (Floating, Nodelocked or Token).
lsidintegerLicense server Id.
lsnbooleanLicense server name.
vnstringLicense server vendor name.
gtnstringGathering type (imported, realtime).
messagestringUnlimited string.

Examples

The following examples make use of GET method.

- To get the list of all License Statistics features, type the following from a command line:

Code Block
languagejs
firstline1
linenumberstrue
curl -H "X-Auth-token: token" "http://yourdomain/api/report/features/json"

 - To obtain feature information filtered by name, version and type, enter the following command:

Code Block
languagejs
firstline1
linenumberstrue
curl --data="fns=a&fv=2.1&ftype=floating" -H "X-Auth-token: token" "http://yourdomain/api/report/features/json"

- To get feature information filtered by Id, enter the following command:

...

languagejs
firstline1
linenumberstrue

...