Page History

...

Parameter

Required

Type

Description

licenseServerId

Yes

array

Arrays of feature IDs in the following format: id1, id2, id3... for example fi=1,2,3,5.

sd

No

string

Specifies the start date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-20. If not provided defaults to today.

ed

No

string

Specifies the end date for which the report will be generated in YYYY-MM-DD format; for example, 2017-01-27. If not provided defaults to [today + 12 months]

granularity

No

integer

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

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

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

filter

No

string

Applies filtering license usage data on all fields.

To filter by 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 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	integer	Specifies granularity of the returned data, and can be one of the following: Quarter - 2 Month - 3 Week - 4 Day - 5 By default, this parameter is set to show monthly usagestatistics.
code	integer	Error code if success equals false, null otherwise.
totalCount	integer	Total number of rows returned.

...

Page tree

Versions Compared

Old Version 9

New Version 10

Key