history.get

Apraksts

integer/array history.get(object parameters)

Metode ļauj izgūt vēstures datus atbilstoši norādītajiem parametriem.

Šī metode var atgriezt dzēstas entītijas vēsturiskos datus, ja housekeeper šos datus vēl nav noņēmis.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāja lomas iestatījumos. Plašāku informāciju skatiet sadaļā Lietotāju lomas.

Parametri

(object) Parametri, kas definē vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parameter Type Description
history integer Vēstures objekta tipi, ko atgriezt.

Iespējamās vērtības:
0 - skaitlisks peldošais punkts;
1 - rakstzīme;
2 - žurnāls;
3 - (noklusējums) skaitlisks bez zīmes;
4 - teksts;
5 - binārs.
hostids ID/array Atgriezt tikai vēsturi no norādītajiem hosts.
itemids ID/array Atgriezt tikai vēsturi no norādītajiem vienumiem.
time_from timestamp Atgriezt tikai vērtības, kas saņemtas pēc norādītā laika vai tā brīdī.
time_till timestamp Atgriezt tikai vērtības, kas saņemtas pirms norādītā laika vai tā brīdī.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: itemid, clock, ns.
search object Atgriezt rezultātus, kas atbilst norādītajam paraugam (nav reģistrjutīgs).

Pieņem objektu, kur atslēgas ir īpašību nosaukumi, bet vērtības ir meklējamās virknes. Ja papildu opcijas nav norādītas, tiks veikta LIKE "%…%" meklēšana.

Neatbalsta meklēšanu pēc value, ja history ir iestatīts uz 6 (JSON).
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež vienu no šīm vērtībām:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Vienuma vēstures datu izgūšana

Atgriezt 10 jaunākās vērtības, kas saņemtas no skaitliska (float) vienuma.

Pieprasījums:

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

Atbilde:

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

Avots

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