...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. | |||||||||
| ${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 is in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00. | |||||||||
| fieldsVisibility | 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 XLS. | |||||||||
| 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 (See this section for more field-specific information.) | |||||||||
| 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.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
success: true,
msg: ${message},
data: [{
uid: ${userId},
un: ${userName},
hn: ${hostName},
sst: ${sessionStartTime},
set: ${sessionEndTime},
il: ${hasUserLdapDetails}
}]
} |
...
| Field | Type | Description |
|---|---|---|
| uid | integer | User ID. |
| un | string | Username. |
| hn | string | Hostname. |
| sst | string | Date returned in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00. |
| set | string | Date returned in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00, "Unknown" or "Still in use". |
| il | boolean | Indicates whether user details have been imported from LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
| success | boolean | Indicates whether your API request was successfully processed. |
Example 1
Say you would like to The following example shows a command that lets you obtain information about all sessions for feature "3" at a specific time point in time. To generate this data set, enter a command similar to the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json" |
Example 2
Let's assume you would like to obtain The following example shows a command that lets you obtain statistics about all sessions for feature "3" at a specific time point. In addition, you want your data to be ordered by username. To generate this data set, enter a command similar to the following.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "orderBy=un" --data "orderDirection=ASC" --data-urlencode "sdt=2015-10-30 00:00" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json" |
Example 3
Say you need to The following example shows a command that lets you view the first 100 sessions for feature "3" at a specific time point. To obtain this data set, enter a command that is similar to the one you can see below.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
| 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/v1/report/feature/3/user-history/json" |
...
where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters can be explained as followsare described below.
| Parameter | Required | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ${featureId} | Yes | integer | Specifies feature-specific parameters. | |||||||||
| ${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 The date is in YYYY-MM-DD format; for example, 2017-05-20. | |||||||||
| sed | Yes | string | Specifies the end date for which the report will be generated. The date is in YYYY-MM-DD format; for example, 2017-05-27. | |||||||||
| fieldsVisibility | 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 (See this section for more field-specific information.) | |||||||||
| 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.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{success: true, msg: ${message}, data: [
uid: ${userId},
un: ${userName},
hn: ${hostName},
sst: ${sessionStartTime},
set: ${sessionEndTime},
il: ${hasUserLdapDetails}
]} |
...
| Field | Type | Description |
|---|---|---|
| uid | integer | User ID. |
| un | string | Username. |
| hn | string | Hostname. |
| sst | string | Date returned in YYYY-MM-DD HH:MM format; for example, 2017-05-20 11:00. |
| set | string | Date returned in YYYY-MM-DD HH:MM format (for example, 2017-05-20 11:00), "Unknown" or "Still in use". |
| il | boolean | Indicates whether user details have been imported from LDAP directory. Note that you cannot filter and order data by this field. |
| msg | string | Error message returned on failure. |
Example 1
Say you would like to The following example shows a command that lets you view all sessions for feature "3" over for a given timeframe. To generate this data set, enter a command similar to the following.
time period.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| Code Block | ||||||
| ||||||
curl --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json" |
Example 2
Let's assume you want to The following example shows a command that lets you see all sessions for feature "3" for a given time period . Additionally, you would like your data to be ordered by username. To generate this data set, enter a command similar to the followingand orders the data by username.
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
curl --data "orderBy=un" --data "orderDirection=ASC" --data "ssd=2015-01-01" --data "sed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/user-history/json" |
Example 3
Let's assume you're interested in viewing The following example shows a command that lets you view the first 100 sessions for feature "3" over a specific timeframe. To obtain this information, enter a command similar to the followingtime period.
| 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/api/v1/report/feature/3/user-history/json" |
...