Skip to content
/AvailabilityReport

Query License Availability

Request

This API allows you to query license availability between two dates or a timeline.

Query
calculatorRequestDtoobject(CalculatorRequestDtoBase)required

Calculator Request

Headers
Content-Typestringrequired
Body
effectiveDatestring^\d{4}-\d{2}-\d{2}$required

Start date from which the license is valid.

Example:"2024-01-22"
expirationDatestring^\d{4}-\d{2}-\d{2}$

End date until which the license is valid. Required if operator max quantity is selected.

Example:"2025-02-21"
quantityinteger, (int32)

Number of licenses available. Required if operator max period is selected.

Example:5
operatorstringrequired

Operator to be used.

Enum:"MAX_QUANTITY""MAX_PERIOD"
Example:"MAX_QUANTITY"
filtersobject(CalculatorFilterRequestDtoV2)required

Filter criteria for the request.

{
  "effectiveDate": "2024-01-22",
  "expirationDate": "2025-02-21",
  "quantity": 5,
  "operator": "MAX_QUANTITY",
  "filters": {
    "usageType": "ASSIGNED",
    "licenseType": "APSW",
    "tier": "Platinum",
    "isTrial": true
  }
}

Responses

success.

Body
statusstring

Status of the response.

Example:"success"
messagestring

Message providing additional details about the response.

Example:"Object created/updated successfully."
dataArray of objects(CalculatorDataDto2)required

List of object containing available license details.

Response
{
  "status": "success",
  "message": "Object created/updated successfully.",
  "data": [
    { … }
  ]
}