This is a translation of the original English documentation page. Help us make it better.

history.get

Опис

integer/array history.get(object parameters)

Метод дозволяє отримувати дані історії за заданими параметрами.

Дивіться також: відомі проблеми

Цей метод може повертати історичні дані видаленої сутності, якщо ці дані ще не були видалені економкою.

Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.

Параметри

(object) Параметри, що визначають бажаний результат.

Метод підтримує такі параметри.

Параметр Тип Опис
history integer Типи об'єктів історії, які потрібно повернути.

Можливі значення:
0 - числове число;
1 - символ;
2 - журнал;
3 - число без знака;
4 - текст.

За замовчуванням: 3.
hostids рядок/масив Повертати лише історію з вказаних хостів.
itemids рядок/масив Повернути лише історію з заданих елементів.
time_from timestamp Повертати лише значення, які були отримані після або в заданий час.
time_till timestamp Повертати лише значення, які були отримані раніше або в заданий час.
sortfield string/array Сортувати результат за заданими властивостями.

Можливі значення: itemid і clock.
countOutput boolean Ці параметри, які є спільними для всіх методів get, детально описано на сторінці довідковий коментар.
редагований логічний
excludeSearch boolean
фільтр об'єкт
ліміт ціле
вивід запит
пошук об'єкт
searchByAny логічний
увімкнено знаки підстановки логічний
порядок сортування рядок/масив
почати пошук логічний

Повернуті значення

(integer/array) Повертає або:

  • масив об'єктів;
  • кількість отриманих об'єктів, якщо використовувався параметр countOutput.

Приклади

Отримання даних історії елементів

Повертає 10 останніх значень, отриманих від числового елемента (float).

Запит:

{
           "jsonrpc": "2.0",
           "method": "history.get",
           "params": {
               "output": "extend",
               "history": 0,
               "itemids": "23296",
               "sortfield": "clock",
               "sortorder": "DESC",
               "limit": 10
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Відповідь:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "itemid": "23296",
                   "clock": "1351090996",
                   "value": "0.085",
                   "ns": "563157632"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090936",
                   "value": "0.16",
                   "ns": "549216402"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090876",
                   "value": "0.18",
                   "ns": "537418114"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090816",
                   "value": "0.21",
                   "ns": "522659528"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090756",
                   "value": "0.215",
                   "ns": "507809457"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090696",
                   "value": "0.255",
                   "ns": "495509699"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090636",
                   "value": "0.36",
                   "ns": "477708209"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090576",
                   "value": "0.375",
                   "ns": "463251343"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090516",
                   "value": "0.315",
                   "ns": "447947017"
               },
               {
                   "itemid": "23296",
                   "clock": "1351090456",
                   "value": "0.275",
                   "ns": "435307141"
               }
           ],
           "id": 1
       }

Джерело

CHistory::get() у ui/include/classes/api/services/CHistory.php.