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.
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which data should be returned. The format can be one of the following: JSON, CSV, XLSX, or PDF. |
| fieldsVisibility | No | json/string | Specifies field visibility settings, for example: { "fid": "1", "fv": "1", "ftype": "1", "lsn": "1", "vn": "1", "gtn": "1"}
where number "1" indicates that a specific field is visible. |
| rn | No | string | Specifies the name of the report that will be displayed once the report has been exported to PDF or XLSX. 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 XLSX types. If provided, it cannot be left empty. |
| filter | No | json/string | Applies filtering to narrow down the results. To filter by a string column, use the following format: [
{
"type": "string",
"field": "${fns | fv | ftype | lsn | vn | gtn}",
"value": "${value}"
}
]
To filter by a numeric column, use the following format: [
{
"type": "numeric",
"comparison": "${gt | lt | eq}",
"field": "${fid | lsid}",
"value": "${value}"
}
]
|
| limit | No | integer | Specifies the number of records that must be returned. The value must be greater than zero. |
| offset | No | integer | Specifies the offset of the first row to return. |
| orderBy | No | string | Specifies 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 |
| orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
Response
The following code block shows an example result of a successful request.
{
"success": ${success},
"msg": ${message},
"data": [{
"fid": ${featureId},
"fns": ${featureName},
"fv": ${featureVersion},
"ftype": ${featureType},
"lsid": ${licenseServerId},
"lsn": ${licenseServerName},
"vn": ${licenseServerVendorName},
"gtn": ${licenseServerGatheringType}
}],
"code": ${errorCode},
"totalCount": ${totalCount}
}
where the response fields can be explained as follows:
| Field | Type | Description |
|---|---|---|
| fid | integer | Feature ID. |
| fns | string | Feature name. |
| fv | string | Feature version. |
| ftype | string | Feature type (Floating, Nodelocked or Token). |
| lsid | integer | License server ID. |
| lsn | boolean | License server name. |
| vn | string | License server vendor name. |
| gtn | string | Gathering type (imported, realtime). |
| success | boolean | Indicates whether your API request was successfully processed. |
| msg | string | Error message returned on failure. |
| code | integer | Error code for unsuccessful request. |
| totalCount | integer | Total number of all matching results. |
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"