history.get

Beschrijving

integer/array history.get(object parameters)

Deze methode maakt het mogelijk om historische gegevens op te halen op basis van de opgegeven parameters.

Deze methode kan historische gegevens retourneren van een verwijderde entiteit als deze gegevens nog niet zijn verwijderd door de housekeeper.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
history integer History-objecttypen die moeten worden geretourneerd.

Mogelijke waarden:
0 - numeriek zwevend;
1 - teken;
2 - log;
3 - numeriek zonder teken;
4 - tekst.

Standaard: 3.
hostids string/array Retourneer alleen de geschiedenis van de opgegeven hosts.
itemids string/array Retourneer alleen de geschiedenis van de opgegeven items.
time_from timestamp Retourneer alleen waarden die na of op het opgegeven tijdstip zijn ontvangen.
time_till timestamp Retourneer alleen waarden die eerder of op het opgegeven tijdstip zijn ontvangen.
sortfield string/array Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: itemid en clock.
countOutput boolean Deze parameters gelden voor alle get-methoden en worden in detail beschreven op de pagina referentiecommentaar.
editable booleaans
excludeSearch boolean
filter object
limiet geheel getal
uitvoer query
zoeken object
searchByAny boolean
searchWildcardsIngeschakeld boolean
sortorde string/array
startZoeken booleaans

Retourwaarden

(integer/array) Retourneert ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Itemgeschiedenisgegevens ophalen

Retourneer 10 laatste waarden die zijn ontvangen van een numeriek (zwevend) item.

Verzoek:

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

Antwoord:

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

Bron

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