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

Obtaining a feature list

You can easily list features recognizable by License Statistics by sending the following HTTP request.

GET /api/v1/feature/${returnType}

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

ParameterRequiredTypeDescription
${returnType}YesstringStandard format option. See Making an API request for details.
standard report optionsNovarious

See Making an API request for details.

Response

On success, report will contain one row for each feature recognizable by License Statistics. Each row consists of columns: 


ColumnFull nameTypeDescriptionVisible by default in export
fidFeature IDintegerInternal License Statistics identification of the feature.Minus (-) No
fnsFeature NamestringFeature name. Yes
ftypeFeature Typeenumeration
See feature type descriptions for details.
Yes
fvFeature VersionstringFeature version. Yes
lsidLicense Server IDintegerInternal License Statistics identification of license server hosting the feature.
Minus (-) No
lsnLicense Serverstring
Name of license server hosting the feature. Yes
vnVendorstringVendor of license server hosting the feature. Yes
gtnGatheringenumerationGathering type of license server hosting the feature. See gathering type descriptions for further details.
Yes

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. 

Example 1

The following example shows a command that gets the list of all License Statistics features.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/feature/json"

 Example 2

The following example shows a command that obtains feature information, filtered by name and version and output to CSV format.

curl --data "filter=[{\"type\"=\"string\", \"field\"=\"fn\", \"value\"=\"abc\"}, {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"}]" 
-H "X-Auth-token: token" "http://yourdomain/api/v1/feature/csv"

Example 3

 The following example shows a command that gets information about a feature with an ID of "1."

curl --data-urlencode "filter=[{\"type\"=\"numeric\", \"field\"=\"fid\", \"comparison\"=\"eq\" \"value\"=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/feature/json"
  • No labels