Метод возвращает отчет по лицензиям, которые истекут за переданное число дней. 

Адрес/v1.0/reports/expiring_licenses
ТипGET
LoginТребуется 

Входные параметры

ПараметрОбязательностьОписаниеВозможные значения
days ОбязателенМаксимальное количество дней до истечения лицензии 
sortby ОпционаленСортировка лицензий.

По умолчанию применяется сортировка по минимальной дате истечения лицензии (expirationdate)

  • expirationdate — сортировка по минимальной дате истечения лицензии;
  • customer — сортировка по покупателю, указанному в заказе;
  • ordernumber — сортировка по номеру заказа;
  • shipmentdate — сортировка по дате отгрузки заказа

direction

Опционален

Направление сортировки. 

По умолчанию используется сортировка asc

  • asc — сортировка от меньшего к большему;
  • desc — сортировка от большего к меньшему

limit

Опционален

Максимальное количество записей, которые можно получить.

По умолчанию равен 100

От 1 до 100 включительно

offset

 

Опционален

Смещение, показывающее с какого порядкового номера записи (с учетом выбранной сортировки) необходимо получить limit записей.

Записи нумеруются с 0


products 

Опционален

Список имен продуктов через запятую, лицензии на которые попадут в отчет


customers

Опционален

Список имен покупателей через запятую, чьи лицензии попадут в отчет


istrial

 

Опционален

Фильтрация на пробные лицензии.

По умолчанию в запросе возвращаются все лицензии

  • false — вернутся только обычные лицензии;
  • true — вернутся только пробные лицензии
Пример запроса
https://station.guardant.ru/v1.0/reports/expiring_licenses?days=50&sortby=expirationdate&direction=desc&limit=2&offset=0&istrial=true&from=1586428828&to=1775731228

Ответ

Возвращает массив expiring_serial_and_dongles, каждый JSON-объект которого включает:

  • поля серийного номера или аппаратного ключа;
  • массив products с продуктами, компонентами и лицензионными ограничениями; 
  • поле order с информацией о заказе; 
  • поле min_expirationdate c датой (в формате unix time) истечения времени действия компонента, которое истечет раньше всех остальных в лицензии; 
  • поле min_seconds_to_expiration с количеством секунд, оставшихся до истечения времени действия компонента, которое истечет раньше всех остальных в лицензии.

Элементы массива expiring_serial_and_dongles (серийные номера и аппаратные ключи) отсортированы в порядке возрастания поля min_expirationdate.

Также возвращается поле xcount, содержащее общее количество объектов данного типа на стороне сервера (без учета значений offset и limit).

Пример результата запроса 
{
    "expiring_serials_and_dongles": [
        {
            "_id": 95552,
            "dongleid": -1636485584,
            "first_activation_date": 1769771881,
            "min_expirationdate": 1777547881,
            "min_seconds_to_expiration": 1727958,
            "model": 1,
            "order": {
                "_id": 76887,
                "date": 0,
                "description": "",
                "ishardwarelicense": false,
                "istrial": true,
                "licenses_activated": 1,
                "number": 164,
                "shipmentdate": 1769771843,
                "status": 8,
                "submitdate": 1769771843,
                "type": 0
            },
            "products": [
                {
                    "_id": 19599,
                    "modification": 0,
                    "name": "rtadmin",
                    "productnumber": 17,
                    "status": 1
                }
            ],
            "serialstring": "bR4Vmn-pSXi9B-fHrw6L-CoKBxX-QGDmJi"
        },
        {
            "_id": 95551,
            "dongleid": -1815480203,
            "first_activation_date": 1769771722,
            "min_expirationdate": 1777547722,
            "min_seconds_to_expiration": 1727799,
            "model": 1,
            "order": {
                "_id": 76886,
                "date": 0,
                "description": "",
                "ishardwarelicense": false,
                "istrial": true,
                "licenses_activated": 1,
                "number": 163,
                "shipmentdate": 1769771674,
                "status": 8,
                "submitdate": 1769771674,
                "type": 0
            },
            "products": [
                {
                    "_id": 19601,
                    "modification": 0,
                    "name": "clock_3",
                    "productnumber": 18,
                    "status": 1
                }
            ],
            "serialstring": "4QBSDE-ByHh2i-VappED-UxKsaW-5zt6V9"
        }
    ],
    "xcount": 2
}
  • No labels
Если вам нужна помощь, обратитесь по адресу
hotline@guardant.ru