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.

Obtaining a license server list

To You can easily list license servers recognizable by registered in License Statistics , use by sending the following HTTP request:.

Code Block
languagejs
firstline1
GET /api/v1/license-server/${returnType}

where the $ indicates a variable value that you can replace with a value that best suits your needs. The possible parameters are as follows: described below.

ParameterRequiredTypeDescription
${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.
fieldsVisibility Nojson/string
Specifies field visibility settings, for example:

 

Code Block
linenumberstrue
{ "lsid": "1", "lsn": "1", "lsh": "1", "lsp": "1", "lsd": "1", "vn": "1", "gtn": "1"}

where number "1" indicates that a specific field is visible.
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.

rnNostringSpecifies 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 to narrow down the results.

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

Code Block
languagejs
firstline1
linenumberstrue
[
    {
        "type": "string",
        "field": "${lsn | lsh | lsd | vn | gtn}",
        "value": "${value}"
    }
]

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

Code Block
linenumberstrue
[
    {
        "type": "numeric",
        "comparison": "${gt | lt | eq}",
        "field": "${lsid | lsp}",
        "value": "${value}"
    }
]
limitNointegerSpecifies the number of records that must 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, lsid, lsn, vn, gtn.
orderDirectionNostringDetermines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order.

Response

The response you get may be similar to the following: 

Code Block
languagejs
firstline1
linenumberstrue
{
	"success": ${success}, 
	"msg": ${message}, 
	"data": [{
  		"lsid": ${featureId}, 
  		"lsn": ${featureName},
  		"lsh": ${featureVersion},
  		"lsp": ${featureType},
  		"lsd": ${licenseServerId},
  		"vn": ${licenseServerName},
  		"gtn": ${licenseServerGatheringType}
	}],
	"code": ${errorCode},
	"totalCount": ${totalCount}
}

where the response fields can be explained as follows:

FieldTypeDescription
lsidintegerLicense server Id.
lsnstringLicense server name.
lshstringLicense server host name
lspintegerLicense server port
lsdintegerLicense server description.
vnstringLicense server vendor name.
gtnstringGathering type (imported, realtime).
successbooleanIndicates whether your API request was successfully processed.
msgstring

Error message returned on failure.

codeinteger

Error code for unsuccessful request.

totalCountintegerTotal number of all matching resultsStandard 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 license server that was queried and is visible for the request. Each row consists of columns: 


ColumnFull nameTypeDescriptionVisible by default in export
lsidLicense Server IDintegerInternal License Statistics identification of the license server(minus)No
lsnLicense ServerstringLicense server name.(tick)Yes
lshHostnamestringHostname.(tick)Yes
lspPortintegerPort number.(tick)Yes
lsdDescriptionstring
Description of the license server.(tick)Yes
lsmnLic ManagerstringManager type of the license server; e.g., LM-X, FlexNet, etc.(tick)Yes
vnVendorstringName of the license server vendor.(tick)Yes
lssStatusenumerationCurrent status of the license server.(tick)Yes
gtnGatheringenumeration
See gathering type descriptions for details.
(tick)Yes
lshalRedundantbooleanTrue if server was configured with redundancy (HAL).(error) Unavailable
lshfHas FeaturesbooleanIndicates whether License Statistics detected any features hosted on the server. True for servers that were successfully queried or imported.(error) Unavailable

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

Examples 

The following examples make use of the GET method. - To get the

Example 1

Say you want to obtain a list of all license servers, type the following from a command line: To generate this data set, enter a command similar to the following.

Code Block
languagejs
firstline1
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json"

 - To obtainExample 2

 If you want to generate license server information filtered by name and port  hostname in csv CSV format, enter the following command:. 

Code Block
languagejs
firstline1
curl --data "filter=[{\"type\"=\"string\", \"field\"=\"lsn\", \"value\"=\"abc\"}, {\"type\"=\"numeric\", \"field\"=\"lsh\", \"value\"=\"some hostname\"}]" 
-H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/csv"

...

Example 3

In order to get information about a license server with id an ID of 1, enter the following command: .

Code Block
languagejs
firstline1
curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"lsid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/license-server/json"

...