Extraction de données brutes de métrique

Disponible à partir de la version 9.2.2. Cette API récupère les données brutes de métrique qui contiennent des informations sur l'utilisation d'éléments de logiciels qui sont installés sur vos ordinateurs. Contrairement à l'interface utilisateur, par le biais de cette API, vous pouvez extraire toutes les données d'historique qui sont stockées dans la base de données.

Pour obtenir des informations sur les logiciels reconnus, utilisez l'API api/sam/v2/software_instances.

Avant de commencer

Utiliser le paramètre limit lors de la prévisualisation de la sortie de l'API

Lorsque vous utilisez l'API api/sam/raw_app_usage_property_values à des fins de test, ajoutez le paramètre limit pour obtenir un temps de réponse plus rapide. Les 100 premiers enregistrements doivent être suffisants pour avoir un aperçu des données disponibles.

https://hostname:port/api/sam/raw_app_usage_property_values?token=token&limit=100
Remarque : Chaque demande d'API doit être authentifiée avec le paramètre token. Vous pouvez les extraire en utilisant API REST pour l'extraction du jeton d'authentification. Vous pouvez également vous connecter à BigFix Inventory, survoler l'icône Utilisateur et cliquer sur Profil. Cliquez ensuite sur Afficher le jeton.
Tableau 1. Descriptions des opérations

Ce tableau comporte deux colonnes et quinze lignes. Pour la onzième ligne, il y a deux niveaux.
Détails de l'opération Description
Fonctionnement GET /api/sam/raw_app_usage_property_values
Finalité Renvoie des données brutes de package.
Méthode HTTP GET
URI de resources https://server_host_name:port_number/api/sam/raw_app_usage_property_values
Relation du lien de l'URL n/a
Paramètres de requête URI n/a
En-têtes de demande
Fonction métier
Accept-Language (Facultatif)
Valeurs
en-US (seul l'anglais est pris en charge)

Sert à négocier la langue de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Charge de la demande Non disponible
Demande Content-Type
  • application/json
En-têtes de réponse
En-tête
Content-Type
Valeurs
application/json

Définit le type de contenu de la réponse.
En-tête
Content-Language
Valeurs
en-US, …

Définit la langue du contenu de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Charge de la réponse App Usage Property Value élément
RéponseContent-Type
  • application/json
Codes de réponse normaux HTTP
  • 200 – OK
Codes de réponse HTTP d'erreur
  • 500 – “Bad Request” si un paramètre de requête contient des erreurs ou est manquant

Le corps du message comprend un message d'erreur détaillé.

Paramètres de requête

Vous pouvez utiliser des paramètres de requête pour limiter le nombre de résultats de votre recherche.
Tableau 2. Paramètres de requête

Ce tableau comporte quatre colonnes et neuf lignes.
Paramètre Description Requis Valeur
columns[] Indique les colonnes à extraire. Si vous n'indiquez pas ce paramètre, un ensemble de colonnes par défaut est extrait. Exemple :
éxtrayez les colonnes name et computer_id :
URL?columns[]=name&columns[]=computer_id
 Non Chaîne
order Indiquez comment trier les données renvoyées. Le sens de tri par défaut des colonnes est croissant. Si vous souhaitez spécifier un tri par ordre décroissant, ajoutez desc au nom de la colonne. Exemple :
Ordre par nom décroissant :
URL?order[]=name desc
 Non Chaîne
limit Indiquez le nombre de lignes à extraire. Si vous omettez ce paramètre, toutes les lignes sont extraites. Pour les versions BigFix Inventory jusqu'à la version 10.0.1, si vous omettez le paramètre "limit", 100 000 lignes sont extraites. Ce nombre est défini par raw_data_api_default_limit dans le panneau Paramètres avancés du serveur.
Remarque : Le paramètre raw_data_api_default_limit a été supprimé depuis BigFix Inventory version 10.0.2.
Non Numérique
décalage Indiquez le nombre de lignes à ignorer pour extraire les résultats. Vous pouvez l'utiliser en même temps que le paramètre de limite pour mettre en page les résultats. Exemple :
éxtrayez 50 enregistrements en commençant après l'enregistrement 150 :
URL?limit=50&offset=150
 Non Numérique
Jeton Identificateur d'authentification utilisateur unique. Vous pouvez afficher votre jeton dans les préférences du profil de BigFix Inventory. Oui Alphanumérique
critères éxtrayez les enregistrements qui correspondent à des conditions spécifiques. Le paramètre doit avoir la structure suivante, écrite sur une seule ligne : 
<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>

<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> 	::= <json-array> | <json-string> | <json-numver> | <json-null>

Pour plus d'informations sur les opérateurs, voir Connecteurs et opérateurs communs.

Exemple : éxtraire des données de métrique à partir de systèmes informatiques avec ID supérieur à 10 :
URL?criteria={ "and": [ ["computer_id", ">", "10"]]}
Pour les colonnes qui utilisent les valeurs de date et d'heure, comme Vu pour la dernière fois, vous pouvez également récupérer les données sur une période au lieu d'une date spécifique. Pour ce faire, utilisez last ou next comme <operator>, puis spécifiez la valeur de temps selon la convention suivante : PxD/PxW/PxM/PxY, où x est un nombre compris entre 1 et 999 et D, W, M ou Y est un identificateur qui représente les jours, semaines, mois ou années, respectivement. Par exemple, pour extraire des systèmes informatiques qui ont communiqué dans les 7 derniers jours, utilisez la demande d'API suivante : 
URL?criteria={"and":[["last_seen","last","P7D"]]}

Exemple de conversation HTTP

Demande
GET api/sam/raw_app_usage_property_values
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
En-tête de réponse
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Corps de réponse (JSON)
 {
  "app_usage_property_id": -1,  
  "computer_id": 2,
  "process": "BESClient.exe",
  "first_used": "2015-03-27T16:28:47Z",
  "last_used": "2015-08-03T11:46:16Z",
  "total_runs": 5,
  "total_time": 10888494,
  "avg_runs_per_day": 0.03943099252280677,
  "avg_run_time": 2177698.8,
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z" 
 }
 {
  "app_usage_property_id": -1,
  "computer_id": 2,
  "process": "BESConsole.exe",
  "first_used": "2015-07-09T11:27:50Z",
  "last_used": "2015-07-13T13:33:42Z",
  "total_runs": 2,
  "total_time": 16767,
  "avg_runs_per_day": 0.4893077201884741,
  "avg_run_time": 8383.5,
  "valid_from": "2015-08-05T14:41:19Z",
  "valid_to": "9999-12-31T23:59:59Z"  
 }