...
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | You can find more general, feature-specific information here. | |||||||||
${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. | |||||||||
sdt | Yes | string | Specifies point in time for which you want to generate the report. The date and time format is as follows: YYYY-MM-DD HH:MM; for example, 2015-01-20 11:00. | |||||||||
fieldsVisibility-I feel like changing this to "fieldVisibility" Can we do this? | No | json/string | Specifies field visibility settings, for example:
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 Excel. | |||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
limit | No | integer | Determines the maximum number of data records that can 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: uid, un, hn, sst, set. | |||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
Field | Type | Description |
---|---|---|
uid | integer | User Id. |
un | string | Username. |
hn | string | Hostname. |
sst | string | The date Date returned in YYYY-MM-DD HH:MM format; for example, 2016-01-20 11:00. |
set | string | The date Date returned in YYYY-MM-DD HH:MM format (for example, 2016-01-20 11:00), "Unknown", or "Still in use". |
il | boolean | This field indicates whether user details have been imported from LDAP directory. Note that currently you cannot filter and order data by this field. |
message | string | An unlimited stringError message returned on failure. |
Example 1
For example, say you would like to view all sessions for feature 3 at a specific time point. To generate such data, enter a command /request that is similar to the following:
...
Let's assume you would like to see all sessions for feature 3 ordered by username at a specific time point. To do this, enter a command /request similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "orderBy=un" --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/report/user-history/3/json" |
Example 3
Say you need to view the first 100 sessions for feature 3 at a specific time point. To do this, you need to enter a command /request similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "limit=100" --data "offset=0" --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/report/user-history/3/json" |
...
If you want to retrieve information about usage history over a specific period of time, we recommend that you use the following URL request template:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
GET /api/report/user-history/${featureId}/${returnType}?ssd=${sessionStartDate}&sed={sessionEndDate}&(additional parameters, as needed) |
...
Parameter | Required | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
${featureId} | Yes | integer | You can find more general, feature-specific information here. | |||||||||
${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. | |||||||||
ssd | Yes | string | Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-20. what about MM:HH ? | |||||||||
sed | Yes | string | Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2016-01-27.what about MM:HH ? | |||||||||
fieldsVisibility-I feel like changing this to "fieldVisibility" Can we do this? | Specifies field visibility settings, for example:
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 Excel. | |||||||||
filter | No | json/string | Applies filtering license usage data on all fields. To filter your data, use the following format:
| |||||||||
limit | No | integer | Determines the maximum number of data records that can 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: uid, un, hn, sst, set. | |||||||||
orderDirection | No | string | Determines whether the sorting results will be displayed in ascending (ASC) or descending (DESC) order. |
...
Field | Type | Description |
---|---|---|
uid | integer | User Id. |
un | string | Username. |
hn | string | Hostname. |
sst | string | The date Date returned in YYYY-MM-DD HH:MM format; for example, 2016-01-20 11:00. |
set | string | The date Date returned in YYYY-MM-DD HH:MM format (for example, 2016-01-20 11:00), "Unknown", or "Still in use". |
il | boolean | This field indicates whether user details have been imported from LDAP directory. Note that currently you cannot filter and order data by this field. |
message | stringAn unlimited string. this means "A string of unlimited length", yes? | Error message returned on failure. |
Example 1
For example, say you would like to view all sessions for feature 3 over some period of time. To generate such data, enter a command /requestthat is similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/report/user-history/3/json" |
Example 2
Let's assume you want to see all sessions for feature 3 ordered by username over a specific period of time. To do this, enter a command /request similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "orderBy=un" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/report/user-history/3/json" |
...
Let's assume you're interested in viewing the first 100 sessions for feature 3 over a specific period of time. To do this, enter a command /request that is similar to the following:
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
curl --data "limit=100" --data "offset=0" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/report/user-history/3/json" |
...