Page History

The Expiring Features endpoint delivers The Expiring Features endpoint delivers metrics that License Statistics collects from the monitored license server. This endpoint is used to fetch license usage metrics specific to the Expiring Features report for features that are nearing expiration.

...

You can easily list features that are nearing expiration by calling this sending the following HTTP GET request:.

GET /api/v1/report/expiry/server/${licenseServerId}/json${returnType}?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}$(additional parameters, as needed)

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.

[
	{ 
		"type": "string",
		"field": "${fns | ftype | fexp | lsn | vn | fv}",
		"value": "${value}"
	}
]

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

{ 
	"fns": "1", 
	"fv": "1", 
	"ftype": "1", 
	"vn": "1", 
	"lsn": "1", 
	"fexp": "1"
}

fid | fns | fv | ftype | vn | lsn | fexp

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

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{
      		"fid": ${featureId},
      		"fns": ${featureName},
      		"ftype": ${featureType},
      		"fv": ${featureVersion},
      		"fexp": ${featureExpires},
      		"lsid": ${licenseServerId},
      		"lsn": ${licenseServerName},
      		"vn": ${licenseServerVendorName},
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

...

Response

On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.

Column	Full name	Type	Description	Visible by default in export
fid	Feature ID	integer	Internal License Statistics identification of the feature.	Yes
fns	Feature Name	string	Feature name.	Yes
fv	Feature Version	enumeration	Feature version.	Yes
ftype	Feature Type	string	See feature type descriptions for details.	Yes
vn	Vendor	string	Name of license server vendor hosting the feature.	Yes
lsid	License Server ID	integer	Internal License Statistics identification of license server hosting the feature.	Yes
lsn	License Server	string	Name of license server hosting the feature.	Yes
fexp	Feature Expires	date	Day when the feature expires.	Yes

Note that the order in the table is the default order of the columns in the exported file.

Example 1

The following example shows a command that obtains statistics about

...

Feature name.

...

vn

...

Error code if success equals false, null otherwise.

...

Example 1

Say you would like to view all features expiring in the next 12 months on all of you license servers. To generate such data, enter a command that is similar to the following: 

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/json"

Example 2

To view The following example shows a command that obtains information about all features expiring in some a specified period of time on one of your license servers that have licenseServerId=1, enter a command similar to this one:a license server with an ID of "1."

curl --data "sd=2015-01-01" --data "ed=2015-03-01" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/json"

...

You can easily list features that are going to expire in some period of time by calling this sending the following HTTP GET request:

GET /api/v1/report/expiry/server/{licenseServerId}/count/grouped/json?sd=${startDateYYYY-MM-DD}&ed=${endDateYYYY-MM-DD}&granularity=${granularity}&filter=${filter}

where the possible parameters are can be explained as follows:

[
	{ 
		"type": "string",
		"field": "${fns | ftype | fexp | lsn | vn | fv}",
		"value": "${value}"
	}
]

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

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

{
	"success": ${success},
  	"msg": ${message},
  	"data": [
    	{
      		"fexpy": ${featureId},
      		"fexpm": ${featureName},
      		"fexpc": ${featureVersion},
      		"granularity": ${granularity}
    	}
  	],
  	"code": ${code},
  	"totalCount": ${count}
}

...

This report supports only JSON format.

This report supports filtering, but does not support other standard options (limiting or ordering).

Response

On success, this report will contain one row for each feature expiring in the specified time range. Each row consists of the following columns.

...

Example 1

Example 1

The following example shows a command that obtains a count of features that will expire for If you would like to obtain count of features that expire every month in the next 12 months on all your servers, enter a command that is similar to the following:license servers.

curl -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/all/count/grouped/json"

Example 2

Say you would like to obtain The following example shows a command that obtains a count of features that will expire for every week in some a specified period of time on a license server with an ID of "1. To generate such data, enter a command that is similar to the following: "

curl --data "sd=2015-01-01" --data "ed=2015-03-01" --data "granularity=4" -H "X-Auth-token: token" "http://yourdomain/api/v1/report/expiry/server/1/count/grouped/json"

...