Page History

...

Parameter

Required

Type

Description

licenseServerId

Yes

integer/string

ID of the license server or 'all' string for all license servers.

sd

No

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. If neither this field, nor "ed" is provided, it defaults to today.

ed

No

string

Specifies the end date for which the report will be generated. The date format is YYYY-MM-DD; for example, 2017-05-27. If neither this field, nor "sd" is provided, it defaults to [today + 12 months].

granularity

No

integerstring

Specifies granularity of the returned data,

and

which can be one of the following:

Quarter - QUARTER or 2
Month - MONTH or 3
Week - WEEK or 4
Day - DAY or 5

By default, this parameter is set to show monthly statistics.

filter

No

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": "${fns | ftype | fexp | lsn | vn | fv}",
		"value": "${value}"
	}
]

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

Code Block

language	js
firstline	1
linenumbers	true

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

...

Field	Type	Description
success	boolean	Indicates that your API request was successfully processed.
msg	string	Error message returned on failure.
fexpy	integer	Year for which the period number has been specified.
fexpm	integer	Number of time period such as day, week, month, etc.
fexpc	integer	Count of features expiring in the given period of time.
granularity	integerstring	Specifies granularity of the returned data, and which can be one of the following: Quarter - QUARTER or 2 Month - MONTH or 3 Week - WEEK or 4 Day - DAY or 5 By default, this parameter is set to show monthly statistics.
code	integer	Error code if success equals false, null otherwise.
totalCount	integer	Total number of rows returned.

...

Page tree

Versions Compared

Old Version 26

New Version 27

Key