history.get

Opis

integer/array history.get(object parameters)

Metoda pozwala na pobranie danych historycznych zgodnie z podanymi parametrami.

Ta metoda może zwrócić dane historyczne usuniętej jednostki, jeśli dane te nie zostały jeszcze usunięte przez porządkowanie.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody mogą zostać wycofane w ustawieniach ról użytkownika. Zobacz Role użytkownika po więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
history integer Typy obiektów historii do zwrócenia.

Możliwe wartości:
0 - liczba zmiennoprzecinkowa;
1 - znak;
2 - log;
3 - liczba całkowita bez znaku;
4 - tekst.

Domyślnie: 3.
hostids string/array Zwraca jedynie historię z podanych hostów.
itemids string/array Zwraca jedynie historię z podanych pozycji.
time_from timestamp Zwraca jedynie wartości, które zostały odebrane po lub o danej godzinie.
time_till timestamp Zwraca jedynie wartości, które zostały odebrane przed lub o danej godzinie.
sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości to: itemid i clock.
countOutput boolean Te parametry wspólne dla wszystkich metod get zostały opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie historii pozycji

Zwróć 10 ostatnich wartości odebranych z pozycji liczbowej (zmiennoprzecinkowa).

Zapytanie:

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

Odpowiedź:

{
           "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
       }

Źródło

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