history.get

Description

integer/array history.get(object parameters)

Cette méthode permet de récupérer les données d’historique selon les paramètres fournis.

Cette méthode peut renvoyer des données historiques d’une entité supprimée si ces données n’ont pas encore été supprimées par le housekeeper.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres des rôles utilisateur. Voir User roles pour plus d’informations.

Paramètres

(object) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Paramètre Type Description
history integer Types d'objets d'historique à renvoyer.

Valeurs possibles :
0 - numérique à virgule flottante ;
1 - caractère ;
2 - journal ;
3 - (par défaut) numérique non signé ;
4 - texte ;
5 - binaire ;
6 - JSON.
hostids ID/array Renvoyer uniquement l'historique des hôtes indiqués.
itemids ID/array Renvoyer uniquement l'historique des éléments indiqués.
maxValueSize integer Nombre maximal d'octets à renvoyer dans la propriété value.

Plage de valeurs possibles : 1-134217728 (1 octet à 128 Mio).
Si défini sur null, aucune limite n'est appliquée.

Par défaut : 65536 (64 Kio).

Comportement du paramètre :
- pris en charge si history est défini sur "binary" ou "JSON"
time_from timestamp Renvoyer uniquement les valeurs reçues après l'heure indiquée ou à cette heure.
time_till timestamp Renvoyer uniquement les valeurs reçues avant l'heure indiquée ou à cette heure.
sortfield string/array Trier le résultat selon les propriétés indiquées.

Valeurs possibles : itemid, clock, ns.
search object Renvoyer les résultats correspondant au motif indiqué (insensible à la casse).

Accepte un objet où les clés sont des noms de propriété et les valeurs sont des chaînes à rechercher. Si aucune option supplémentaire n'est fournie, une recherche LIKE "%…%" sera effectuée.

La recherche par value n'est pas prise en charge si history est défini sur 6 (JSON).
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valeurs retournées

(integer/array) Retourne soit :

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des données d'historique d'un élément

Renvoie les 10 dernières valeurs reçues d'un élément numérique (float).

Requête :

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

Réponse :

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

Source

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