Extraction de données brutes de fichiers analysés

Disponible à partir de la version 9.2.2. Utilisez l'opération GET sur l'élément /api/sam/raw_file_facts pour extraire des informations sur tous les fichiers reconnus sur les ordinateurs de votre infrastructure. L'API renvoie les détails des fichiers existants, ainsi que les données historiques sur les fichiers retirés. Par défaut, les données brutes sont conservées pendant 7 jours. Pour modifier cette période, accédez à Gestion > Paramètres avancés du serveur et modifiez la valeur du paramètre raw_data_api_history_keep_days.

Remarque

Utilisateur Pour obtenir des informations sur les logiciels détectés, 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_file_facts à 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_file_facts?token=token&limit=100

Droits

Icône représentant un utilisateur. Vous devez disposer du droit Afficher les données brutes pour effectuer cette tâche.

URL de la ressource

https://hostname:port/api/sam/raw_file_facts?token=token

Informations sur les ressources

Tableau 1. Informations sur les ressources
Ce tableau comporte deux colonnes et six lignes.
Détails de l'opération	Description
Méthode HTTP	`GET`
En-têtes de demande	Fonction métier `Accept-Language` (Facultatif) Valeurs en-US (seul l'anglais est pris en charge) Négocie la langue de la réponse. Si l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Format de demande	`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êtes de 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	`File Fact` element
Format de réponse	`application/json`
Codes de réponse	`200 – OK` `500 – “Bad Request”` si un paramètre de requête contient des erreurs ou est manquant

Description du schéma

Pour extraire la liste de toutes les colonnes renvoyées par cette API REST, ainsi que leurs descriptions, utilisez la demande suivante :

GET api/sam/schemas/raw_file_fact.json?token=token

Colonnes disponibles

Tableau 2. Colonnes contenant des informations sur les fichiers examinés
Colonne	Description	Affichée par défaut	Type
computer_id	Identificateur de l'ordinateur sur lequel le fichier a été reconnu.	✓	Chaîne
path	Chemin dans lequel le fichier a été reconnu.	✓	Chaîne
nom	Nom du fichier reconnu.	✓	Chaîne
taille	Taille du fichier reconnu.	✓	éntier
version	version du fichier reconnu si disponible.	✓	Chaîne
md5	Total de contrôle MD5 du fichier.	✓	Chaîne
sha256	Total de contrôle SHA256 du fichier.	✓	Chaîne
valid_from	Date de la première importation qui contenait des informations sur le fichier.	✓	Chaîne
valid_to	Date de la première importation qui ne contenait pas d'informations sur le fichier. La valeur `9999-12-31T23:59:59Z` indique que le fichier est toujours en cours de reconnaissance.	✓	Chaîne
win_hdr_product_name	Nom du produit avec lequel le fichier est distribué.		Chaîne
win_hdr_copyright	Les mentions de droits d'auteur qui s'appliquent au fichier.		Chaîne
win_hdr_product_version	version du produit avec lequel le fichier est distribué.		Chaîne
win_hdr_description	La description du fichier.		Chaîne
win_hdr_company	La société qui a produit le fichier.		Chaîne
win_hdr_trademarks	Marques de commerce et marques déposées qui s'appliquent au fichier.		Chaîne

Les colonnes commençant par "win_hdr_" doivent être activées. Pour plus de détails, reportez-vous à Activation de la collecte de propriétés supplémentaires d'exécutables Windows.

Associations applicables

Vous pouvez par ailleurs extraire des données des associations suivantes :

computer

Paramètres de requête

Tableau 3. 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, seules les colonnes par défaut sont extraites. Exemple : éxtraire le nom et la taille d'un fichier : `URL?columns[]=name&columns[]=size`		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 : Trier par de nom `URL?order[]=name desc`		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. Exemple : éxtraire 100 enregistrements `URL?limit=100` Remarque : Le paramètre raw_data_api_default_limit a été supprimé depuis BigFix Inventory version 10.0.2.		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 limit pour mettre en page les résultats. Exemple : éxtrayez 50 enregistrements en commençant après l'enregistrement 150 : `URL?limit=50&offset=150`		Numérique
Jeton	Identificateur d'authentification utilisateur unique. Vous pouvez l'extraire en utilisant l'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.	✓	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 fichiers analysés à 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. Exemple : éxtraire les informations des ordinateurs signalés pour la première fois dans BigFix Inventory au cours des sept derniers jours `URL?criteria={"and":[["valid_from","last","P7D"]]}`

Exemple de conversation - Colonne par défaut

Demande

GET api/sam/raw_file_facts
?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

Corps de la réponse

 {
  "computer_id": 5,
  "path": "C:\BES\BESAirgapTool",
  "name": "BESAirgapTool.exe",
  "size": 92174,
  "version": null,
  "valid_from": "2015-07-31T07:03:21Z"
  "valid_to": "9999-12-31T23:59:59Z"
 }
 {
  "computer_id": 5,
  "path": "C:/Program Files/ibm/SQLLIB/BIN",
  "name":"db2set.exe",
  "size": 81768,
  "version": "10.1",
  "valid_from": "2015-07-31T07:03:21Z",
  "valid_to": "9999-12-31T23:59:59Z"
  }

Exemple de conversation - Paramètres Windows supplémentaires

Demande

GET api/sam/raw_file_facts
?columns[]=win_hdr_product_name
&columns[]=win_hdr_copyright
&columns[]=win_hdr_product_version
&columns[]=win_hdr_description
&columns[]=win_hdr_company
&columns[]=win_hdr_trademarks
&criteria=
{"and":[["win_hdr_copyright","!=",""]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081
Accept: application/json
Accept-Language: en-US

Réponse

{
"win_hdr_product_name":"Microsoft (R) Visual Studio (R) 2010",
"win_hdr_copyright":"Ac Microsoft Corporation. All rights reserved.",
"win_hdr_product_version":"10.0.40219.1",
"win_hdr_description":"WebDev.WebServer40.exe",
"win_hdr_company":"Microsoft Corporation",
"win_hdr_trademarks":""
}