...
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | |||||||||
fns | No | string | Applies quick filtering on a feature name. | |||||||||
fv | No | string | Applies quick filtering on a feature version. | |||||||||
ftype | No | string | Applies quick filtering on a feature type. | |||||||||
lsn | No | string | Applies quick filtering on a license server name. | |||||||||
vn | No | string | Applies quick filtering on a license server vendor name. | |||||||||
gtn | No | string | Applies quick filtering on a license server gathering type. | |||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
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. |
...
Note: By default, filter rules are case-insensitive.
There is also another, already deprecated, endpoint that you can use:
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/report/feature/${returnType} |
...
Response
...
Applies filtering license usage data on all fields. To filter your data, use the following format:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
[{"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:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ 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:
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. |
success | boolean | This field indicates that the API request was successfully processed. |
vn | string | License server vendor name. |
gtn | string | Gathering type (imported, realtime). |
msg | string | Unlimited 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 | ||||
---|---|---|---|---|
| ||||
curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
- To obtain feature information filtered by name, version and type, enter the following command:
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data "fns=a&fv=2.1&ftype=floating" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
- To get feature information filtered by Id, enter the following command:
Code Block | ||||
---|---|---|---|---|
| ||||
curl --data-urlencode "filter=[{\"value\": 1, \"field\": \"fid\"}]" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/json" |
There is also another, already deprecated, endpoint that you can use:
Code Block | ||||
---|---|---|---|---|
| ||||
GET /api/v1/report/feature/${returnType} |
where the possible parameters are as follows: Anchor feature list def feature list def
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
${returnType} | Yes | string | Specifies the format in which license usage data should be returned. The format can be one of the following: json, csv, xls or pdf. | |||||||||
fns | No | string | Applies quick filtering on a feature name. | |||||||||
fv | No | string | Applies quick filtering on a feature version. | |||||||||
ftype | No | string | Applies quick filtering on a feature type. | |||||||||
lsn | No | string | Applies quick filtering on a license server name. | |||||||||
vn | No | string | Applies quick filtering on a license server vendor name. | |||||||||
gtn | No | string | Applies quick filtering on a license server gathering type. | |||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
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. |
Note: By default, filter rules are case-insensitive.
The response is exactly the same as for above endpoint.