history.get

Description

integer/array history.get(object parameters)

Le procédé permet de récupérer des données d'historique en fonction des paramètres donnés.

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

Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur 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	Les types d’objets d’historique à renvoyer. Valeurs possibles : 0 - flottant numérique ; 1 - caractère ; 2 - log ; 3 - numérique non signé ; 4 - texte. Par défaut : 3.
hostids	string/array	Renvoie uniquement l'historique des hôtes donnés.
itemids	string/array	Renvoie uniquement l'historique des éléments donnés.
time_from	timestamp	Renvoie uniquement les valeurs reçues après ou à l'heure indiquée.
time_till	timestamp	Renvoie uniquement les valeurs reçues avant ou à l'heure indiquée.
sortfield	string/array	Trier le résultat par les propriétés données. Les valeurs possibles sont : `itemid` et `clock`.
countOutput	boolean	Ces paramètres, communs à toutes les méthodes `get` sont décrits dans les commentaires de référence.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
search	object
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 des éléments

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

Requête :

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

Documentation