EN
Español
English
Português
    Software/Get Software License Listing

    Get Software License Listing

    This service lists software licensing packages registered in ADM, displaying information on creation, expiration, allocated quantity, available quantity, and expiration status.

    Request Details/Get Software License Listing

    Verb: POST
    URL: *{url}/admapi/software/licenses/packages


    Parameters

    Parameters for this request that must be sent in the body of the request:

    Field Description Guy Obligatory Possible Values
    pageIndex Page index used for pagination. Start at 0. Whole Yes -
    pageSize Number of results per page. Whole Yes -
    orderField Field by which the list will be sorted. Text Yes assigned,
    creationDate,
    expirationDate,
    name,
    packageName,
    quantity
    orderType Type of ordering: ascending or descending. Text Yes ASC,DESC
    search Free text for search and filtering by name or attributes. Text no Values that can be used for search:
    - Name
    - packageName
    filterSelected List of filters applied to narrow down results. Array no -
    filterSelected[].category Filter category. Text Yes ExpirationStatus
    filterSelected[].ids List of numeric identifiers of the filter. Array no -
    filterSelected[].strings List of filter text values. Array no Expired.
    AboutToExpire.
    Near.
    UpToDate.


    Answer

    • Code: 200 – OK Answer:True
    Field Description Guy
    Id Unique identifier of the software license package. Whole
    Name Name of the license package. Text
    packageName License package name (possibly equivalent to name or an additional identifier). Text
    creationDate Date of creation of the license package in ADM. Date/Text
    expirationDate Expiration date of the license package. Date/Text
    quantity Total number of licenses in the package. Whole
    assignedQuantity Number of licenses assigned. Whole
    availableQuantity Number of licenses available. Whole
    expirationStatus Expiration status based on days remaining (Expired, AboutToExpire, Near, UpToDate). Text
    • Code: 204 - No Content Answer: The query was successfully processed but there is no data to return.
    • Code: 400 - Bad Request Answer: The request body is invalid or missing required parameters.
    • Code: 401 - Unauthorized Answer: The authentication token is invalid, expired, or not included.
    • Code: 500 - Internal Server Error Answer: Internal server error when processing the request.


    License expiration statuses

    Statuses are determined solely based on the days remaining from the current system date. The creation date is not used.

    Days remaining Technical status Meaning
    0 or less Expired The license has already expired
    Between 1 and 30 AboutToExpire Expires in less than a month
    Between 31 and 60 Near Close to victory
    More than 60 UpToDate The license is valid

    A brief functional explanation:

    • The calculation starts from the days remaining between the expiration date and the current system date.
    • If the result is 0 or negative, the status is Expired.
    • If it is between 1 and 30, the status is AboutToExpire.
    • If it is between 31 and 60, the state is Near.
    • If it is greater than 60, the state is UpToDate.