Extraction de l'inventaire matériel (v2)

Disponible à partir de la version 9.2.8. Utilisez l'opération GET sur l'élément api/sam/v2/computers pour demander des informations sur les ordinateurs de votre infrastructure. L'API renvoie les détails des ordinateurs existants, ainsi que les données historiques sur les ordinateurs retirés.

Droits

Utilisateur Vous devez disposer des droits Afficher les nœuds finaux et Afficher l'inventaire matériel pour utiliser cette API.

URL de la ressource

https://hostname:port/api/sam/v2/computers?token=token

Informations sur les ressources

Tableau 1. Informations sur les ressources
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 l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Charge de la réponse	`Computer Systems` 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/v2/schemas/computer.json?token=token

Colonnes disponibles

Tableau 2. Colonnes disponibles
Colonne	Description	Affichée par défaut	Type
id	Identificateur de l'ordinateur, tel que défini dans BigFix Inventory.		Numérique
bigfix_id	Identificateur de l'ordinateur, tel que défini dans BigFix.		Numérique
nom	Nom de l'ordinateur.	✓	Chaîne
dns_name	Serveur de noms de domaine de l'ordinateur.		Chaîne
ip_address	Adresse IP de la machine.	✓	Chaîne
os	Système d'exploitation de la machine.	✓	Chaîne
os_type	Type du système d'exploitation de l'ordinateur.		Chaîne
first_seen	Date et heure auxquelles l'ordinateur s'est signalé à BigFix pour la première fois. L'heure est spécifiée dans le fuseau horaire GMT.		Chaîne
last_seen	Date et heure auxquelles l'ordinateur s'est signalé à BigFix pour la dernière fois. L'heure est spécifiée dans le fuseau horaire GMT.	✓	Chaîne
is_deleted	Indique si l'ordinateur a été retiré.	✓	Valeur boléenne
deletion_date	Date et heure de retrait de l'ordinateur. L'heure est spécifiée dans le fuseau horaire GMT.		Chaîne
is_managed_by_vm_manager	Indique si l'ordinateur est géré par un gestionnaire de machine virtuelle.		Valeur boléenne

Associations applicables

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

Remarque : L'extraction des données de plusieurs associations d'API dans une même demande risque d'augmenter le temps de réponse.

Pour plus d'informations le mode d'utilisation des associations d'API, voir : Associations d'API REST.

Important : Toutes les associations fournissent des données sur les éléments qui existent actuellement dans l'infrastructure. Pour les ordinateurs retirés et les logiciels désinstallés, ces associations renvoient null.

Paramètres de requête

Tableau 3. Paramètres de requête
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 : extraction du nom et de la version du produit `URL?columns[]=first_seen`		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 : classement des ID ordinateur suivant l'ordre décroissant : `URL?order[]=id desc`		Chaîne
limit	Indiquez le nombre de lignes à extraire. Si vous omettez ce paramètre, toutes les lignes sont extraites. Exemple : éxtraire 100 enregistrements `URL?limit=100`		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`		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 : extraction des ordinateurs ayant envoyé des données pour la première fois au cours d'une plage de dates spécifique : `URL?criteria={"and":[["first_seen", ">", "1970-01-01T00:00:00+00:00Z"], ["first_seen", "<", "1970-01-02T00:00:00+00:00Z"]]}` Pour les colonnes qui utilisent les valeurs de date et d'heure, 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 : extraction des ordinateurs signalés pour la première fois au cours des sept derniers jours `URL?criteria={"and":[["first_seen","last","P7D"]]}`		Chaîne

Exemple de conversation - Colonne par défaut

Demande

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

Corps de la réponse

[{
"name":"NC9143126194",
"ip_address":["9.143.126.194"],
"os":"Win2012R2 6.3.9600",
"last_seen":"2016-09-22T10:32:12Z",
"is_deleted":1
}]

Exemple de conversation - Toutes les colonnes

Demande

GET api/sam/v2/computers?columns[]=id&columns[]=bigfix_id
&columns[]=name&columns[]=dns_name
&columns[]=ip_address&columns[]=os&columns[]=os_type
&columns[]=first_seen&columns[]=last_seen&columns[]=is_deleted
&columns[]=deletion_date&columns[]=is_managed_by_vm_manager
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

Corps de la réponse

[{
"id":2,
"bigfix_id":11368943,
"name":"NC9143126194",
"dns_name":"NC9143126194",
"ip_address":["9.143.126.194"],
"os":"Win2012R2 6.3.9600",
"os_type":"Windows",
"first_seen":"2016-10-04T09:42:55Z",
"last_seen":"2016-09-22T10:32:12Z",
"is_deleted":1,
"deletion_date":"2016-12-19T09:40:14Z",
"is_managed_by_vm_manager":0
}]

Exemple de conversation - Colonne supplémentaire

Demande

GET api/sam/v2/computers?columns[]=id
&columns[]=is_deleted&columns[]=deletion_date
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

Corps de la réponse

[{
"id":21,
"is_deleted":1,
"deletion_date":"2016-10-18T14:51:52Z"
}]

Exemple de conversation - Association

Demande

GET api/sam/v2/computers?columns[]=id
&columns[]=computer_health.catalog_version
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

Corps de la réponse

[{
"id":1,
"catalog_version":1304630
}]