Page History

...

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 ID of the feature for which you want to view denied requests.

${returnType}

Yes

string

Specifies the format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf.

sd

Yes

string

Specifies the starting date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20.

ed

Yes

string

Specifies the end date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20. The date is inclusive, meaning that all data from a particular day will be included in the report.

fieldsVisibility

No

json/string

Specifies field visibility settings, for example:

Code Block

language	js
firstline	1
linenumbers	true

{"un": "1", "hn": "1", "ldt": "1", "ldtc":"1"}

where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

rn

No

string

Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. 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 XLS types. If provided, it cannot be left empty.

filter

No

json/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format.

Code Block

language	js
firstline	1
linenumbers	true

[
	{ 
		"type": "string",
		"field": "${un | hn | ldt}",
		"value": "${value}"
	}
]

To filter by a numeric column, use the following format.

Code Block

language	js
firstline	1

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "ldtc",
		"value": "${value}" 
	}
]

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:

un, hn, ldt, ldt

(See this section for more field-specific information.)

orderDirection

No

string

Determines whether the sorting results will be displayed in an ascending (ASC) or a descending (DESC) order.

Response

The following code block shows an example result of a successful request.

Code Block

language	js
firstline	1
linenumbers	true

  {
      success: ${success},
      msg: ${message},
      data: [{
        "un": ${userName},
        "hn": ${hostName},
        "ldt": ${licenseDenialTime},
        "ldtc": ${licenseDenialTotalCount}
      }],
	  "code": ${errorCode},
	  "totalCount": ${totalCount}
  }

...

Field	Type	Description
un	string	Username.
hn	string	Hostname.
ldt	string	Date on which the denial took place in YYYY-MM-DD format.
ldtc	string	Total number of denied license checkout requests.
msg	string	Error message returned on failure.
success	boolean	Indicates whether your API request was successfully processed.
code	integer	Error code for unsuccessful request.
totalCount	integer	Total number of all matching results.

Example 1

Say you would like to The following example shows a command that lets you obtain information about denials for feature "3" over a given timeframe. To generate this data set, enter a command similar to the following.time period.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Example 2

Let's assume you want to The following example shows a command that lets you obtain information about all denials for feature "3" over a specific timeframe. In addition, you want your data to be time period, with data ordered by username. To generate such data set, enter a command similar to the following.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "orderBy=un" --data "orderDirection=ASC" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Example 3

Say you're interested in viewing the The following example shows a command that lets you view the first 100 denials for feature "3" over a given timeframe. To generate such data set, enter a command that is similar to the one you can see below.time period.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "limit=100" --data "offset=0" --data "sd=2015-01-01" --data "ed=2015-01-02" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/json"

Please keep in mind that you You can also put parameters directly into the URL, e.g. to generate data the URL; for the above example, the command you'll need to enter will would be similar to the following.

...

where $ indicates a variable value that you can replace with a value that best suits your needs and the . The possible parameters are as follows:described below.

Parameter

Required

Type

Description

${featureId}

Yes

integer

Specifies ID of the feature for which you want to view grouped checkout denials.

${returnType}

Yes

string

Specifies format in which the data should be returned. The format can be one of the following: json, csv, xls or pdf.

sd

Yes

string

Specifies starting date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20.

ed

Yes

string

Specifies end date from which you want to generate the report. The date is in YYYY-MM-DD format; for example, 2017-05-20. The date is inclusive, meaning that all data from a particular day will be included in the report.

grat

Yes

integer

Specifies granularity of the returned data, and can be one of the following:

Quarter - 2
Month - 3
Week - 4
Day - 5
Hour - 6

fieldsVisibility

No

json/string

Specifies field visibility settings, for example:

Code Block

language	js
firstline	1
linenumbers	true

{"ldt": "1", "ldtc":"1"}

where number "1" indicates that a specific field is visible.
Note that the order of the settings you make is important – when exported, the fields will be visible in exactly the same order you specify here.

rn

No

string

Specifies the name of the report that will be displayed once the report has been exported to PDF or XLS. 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 XLS types. If provided, it cannot be left empty.

filter

No

json/string

Applies filtering license usage data on all fields.

To filter by a string column, use the following format:

Code Block

language	js
firstline	1
linenumbers	true

[
	{ 
		"type": "string",
		"field": "ldt",
		"value": "${value}"
	}
]

To filter by a numeric column, use the following format:

Code Block

language	js
firstline	1

[
	{ 
		"type": "numeric", 
		"comparison": "${gt | lt | eq}", 
		"field": "ldtc",
		"value": "${value}" 
	}
]

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:

un, hn, ldt, ldt

(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

language	js
firstline	1
linenumbers	true

  {
      success: ${success},
      msg: ${message},
      data: [{
        "ldt": ${licenseDenialTime},
        "ldtc": ${licenseDenialTotalCount}
      }]
  }

...

Field	Type	Description
ldt	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.
ldtc	string	Total number of denied license checkout requests.
msg	string	Error message returned on failure.
success	boolean	Indicates if the API request was successfully processed.
msg	string	Error message returned on failure.
code	integer	Error code for unsuccessful request.
totalCount	integer	Total number of denied license checkout requests.

Example 1

Say you would like to obtain The following example shows a command that obtains information about denials for feature "3" grouped by month. To generate such data set, enter a command similar to the following"3" grouped by month.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "sd=2015-01-01" --data "ed=2015-01-02" --data "grat=3" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Example 2

Let's assume you want to The following example shows a command that lets you see all denials grouped by quarter for feature "3" . In addition, you want to obtain data that is ordered by the total denial count from highest to lowest. To generate such data set, enter a command similar to the following.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "orderBy=ldtc" --data "orderDirection=DESC" --data "sd=2014-01-01" --data "ed=2015-01-01" --data "grat=2" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Example 3

Let's say you're interested in viewing the The following example shows a command that lets you view the first 100 denials for feature "3" over a specific timeframe. In addition, you want your data to be time period, grouped by hour. To generate such data set, enter a command similar to the following.

Code Block

language	js
firstline	1
linenumbers	true

curl --data "limit=100" --data "offset=0" --data "sd=2013-01-01" --data "ed=2015-01-02" --data "grat=6" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json"

Please keep in mind that you You can also put parameters directly into the URL, e.g. to generate data ; for the above example, the command would look like thisthe following:

Code Block

language	js
firstline	1
linenumbers	true

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/feature/3/denials/grouped/json?limit=5&offset=2&sd=2013-01-01&ed=2015-01-02&grat=6"

...

Page tree

Versions Compared

Old Version 58

New Version 59

Key