...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
where Where the response fields can be explained as follows.Anchor fields def fields def
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/feature/usage-history/comparison/json${returnType}?fi=${featureIds}&sd=${startDate}&ed=${endDate}&granularity=${granularity} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
GET /api/v1/report/usage-history/comparison/json${returnType}?fi=${featureIds}&sd=${startDate}&ed=${endDate}&granularity=${granularity} |
...
| Parameter | Required | Type | Description |
|---|---|---|---|
| ${returnType} | Yes | string | Specifies the format in which usage history comparison data will be returned. The format can be one of the following: json, csv, xls, xlsx or pdf. |
| featureIds | Yes | array | Arrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5. |
| sd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-20. |
| ed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-05-27. |
| granularity | Yes | integer | Specifies granularity of the returned data, which can be one of the following:
|
Currently the report is only returned only in JSON syntax. There are plans to introduce CSV, XLS and PDF formats in the future.
The following code block shows an example The following code block shows an example result of a successful request.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId_1},
"fns": ${featureName},
"ludftype": ${datefeatureType},
"luminfv": ${minUsedfeatureVersion},
"lualud": ${averageUseddate},
"lumaxlumin": ${maxUsedminUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
},
{
"fid": ${featureId_2},
"lud": ${date},
"luminfns": ${minUsedfeatureName},
"luaftype": ${averageUsedfeatureType},
"fv": ${featureVersion},
"lumaxlud": ${maxUseddate},
"lbminlumin": ${minBorrowedminUsed},
"lbmaxlua": ${maxBorrowedaverageUsed},
"ldtclumax": ${denialsmaxUsed},
"hulbmin": ${hoursUsedminBorrowed},
"ftlbmax": ${totalmaxBorrowed},
}
],
"codeldtc": ${codedenials},
"totalCounthu": ${counthoursUsed}
} |
...
,
"ft": ${total}
}
],
"code": ${code},
"totalCount": ${count}
} |
where the response fields can be explained as follows.Anchor fields def fields def
| Field | Type | Description |
|---|---|---|
| success | boolean | Indicates whether your API request was successfully processed. |
| msg | string | Error message returned on failure. |
| fid | integer | Feature ID. |
| fns | string | Feature name. |
| ftype | string | Feature type. |
| fv | string | Feature version. |
| lud | string | Indicates period of time for which usage information is generated, i.e. date and time for hourly usage and dates for the remaining granularity options. |
| lumin | integer | Minimal licenses used count for a given date. |
| lua | float | Average licenses used count for a given date. |
| lumax | integer | Maximum licenses used count for a given date. |
| lbmin | integer | Minimal licenses borrowed count for a given date. |
| lbmax | integer | Maximum licenses borrowed count for given date. |
ldtc | integer | Denials count. |
| hu | float | Hours used. |
| ft | integer | Feature total. |
| code | integer | Error code if success equals false, null otherwise. |
| totalCount | integer | Total number of rows returned. |
Obtaining information about usage history for a license serverAnchor lsApi lsApi
| lsApi | |
| lsApi |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"success": ${success},
"msg": ${message},
"data": [
{
"fid": ${featureId_1},
"fns": ${featureName},
"ftype": ${
featureType},
"fidfv": ${featureId_1featureVersion},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total}
},
{
"fnsfid": ${featureNamefeatureId_1},
"ftype "fns": ${featureTypefeatureName},
"fv": ${featureVersion}
ftype": ${featureType},
{
"fidfv": ${featureId_1featureVersion},
"lud": ${date},
"lumin": ${minUsed},
"lua": ${averageUsed},
"lumax": ${maxUsed},
"lbmin": ${minBorrowed},
"lbmax": ${maxBorrowed},
"ldtc": ${denials},
"hu": ${hoursUsed},
"ft": ${total},
"fns": ${featureName},
"ftype "hu": ${featureTypehoursUsed},
"fvft": ${featureVersiontotal}
}
],
"code": ${code},
"totalCount": ${count}
} |
...
| Field | Type | Description | ||
|---|---|---|---|---|
| success | boolean | Indicates whether your API request was successfully processed. | ||
| msg | string | Error message returned on failure. | ||
| fid | integer | Feature ID. | ||
| fns | string | Feature name. | ||
| ftype | string | Feature type. | ||
| fv | string | Feature version. | ||
| lud | string | Indicates period of time for which usage information is generated, i.e. date and time for hourly usage and dates for the remaining granularity options. | ||
| lumin | integer | Minimal licenses used count for given date. | ||
| lua | float | Average licenses used count for given date. | ||
| lumax | integer | Maximum licenses used count for given date. | ||
| lbmin | integer | Minimal licenses borrowed count for given date. | ||
| lbmax | integer | Maximum licenses borrowed count for given date. | ||
ldtc | integer | Denials count. | ||
| hu | float | Hours used. | ||
| ft | integer | Feature total. | ||
| code | integer | Error code if success equals false, null otherwise. | ||
| totalCount | integer | fv | string | Total number of rows returned. |
| fns | string | Feature name. | ||
| ftype | string | Feature type. | ||
| Feature version. |
If any of the requests has invalid or missing parameters, HTTP 400 BAD REQUEST is returned.
...