history.get

Beschrijving

integer/array history.get(object parameters)

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

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

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode te bellen kunnen 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 Omschrijving
history integer Geeft de gewenste typen historische objecten terug.

Mogelijke waarden:
0 - numerieke zwevende komma;
1 - karakter;
2 - logboek;
3 - (standaard) numerieke niet-ondertekende;
4 - tekst.
hostids string/array Geeft alleen geschiedenis terug van de opgegeven hosts.
itemids string/array Geeft alleen geschiedenis terug van de opgegeven items.
time_from timestamp Geeft alleen waarden terug die zijn ontvangen na of op het opgegeven tijdstip.
time_till timestamp Geeft alleen waarden terug die zijn ontvangen vóór of op het opgegeven tijdstip.
sortfield string/array Sorteer het resultaat op de opgegeven eigenschappen.

Mogelijke waarden: itemid, clock.
countOutput boolean Deze parameters, die gemeenschappelijk zijn voor alle get-methoden, worden in detail beschreven op de referentiecommentaar pagina.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Ophalen van itemgeschiedenisgegevens

Retourneer de 10 nieuwste waarden die zijn ontvangen van een numeriek (zwevendekommagetal) item.

Aanvraag:

{
           "jsonrpc": "2.0",
           "method": "history.get",
           "params": {
               "output": "extend",
               "history": 0,
               "itemids": "23296",
               "sortfield": "clock",
               "sortorder": "DESC",
               "limit": 10
           },
           "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.