Page History

Obtaining a feature list

You can easily list To list all the features recognizable by License Statistics , use one of by sending the following HTTP request:.

GET /api/v1/feature/${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.

[{"type": "${string | numeric}", "value": stringOrNumericValue, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}]

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

There is also another, already deprecated, endpoint that you can use:

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

...

Response

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

Column	Full name	Type	Description	Visible by default in export
fid	Feature ID	integer	Internal License Statistics identification of the feature.	No
fns	Feature Name	string	Feature name.	Yes
ftype	Feature Type	enumeration	See feature type descriptions for details.	Yes
fv	Feature Version	string	Feature version.	Yes
lsid	License Server ID	integer	Internal License Statistics identification of license server hosting the feature.	No
lsn	License Server	string	Name of license server hosting the feature.	Yes
vn	Vendor	string	Vendor of license server hosting the feature.	Yes
gtn	Gathering	enumeration	Gathering 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.

...

[{"type": "${string | numeric}", "value": stringOrNumericValue, "field": "${fid | fns | fv | ftype | lsid | lsn | vn | gtn}"}]

...

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

Response

The response you get may be similar to the following:

{
success: true, 
msg: ${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:

...

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:

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

 Example 2

The following example shows a command that obtains - To obtain feature information, filtered by name , and version and type, enter the following command:output to CSV format.

curl --data "fns=a&fv=2.1&ftype=floating" filter=[{\"type\"=\"string\", \"field\"=\"fn\", \"value\"=\"abc\"}, {\"type\"=\"string\", \"field\"=\"fv\", \"value\"=\"2.1\"}]" 
-H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/jsoncsv"

Example 3

 The following example shows a command that gets information about a feature with an ID of "1."- To get feature information filtered by Id, enter the following command:

curl --data-urlencode "filter=[{\"valuetype\"=\"numeric\": 1, \"field\"=\"fid\", \"fieldcomparison\"=\"eq\": \"value\"fid=\"1\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json"