API logicielle unifiée pour combiner les données de package et les données d'instance logicielle

10.0.5 Avec l'API /api/sam/unified/current/software, vous pouvez afficher ensemble les instances logicielles et les données de package actuellement installées.

Intégrations simplifiées avec une API couvrant les logiciels reconnus

L'API affiche les informations suivantes :
  • Instances logicielles et données de package actuellement installées
  • Instances logicielles et données de package qui ne sont pas supprimées
  • Données de package non reconnues
  • Les données de l'ordinateur accessibles via l'association d'ordinateurs, telles que association d'ordinateurs

Permissions

Utilisateur Vous devez disposer des droits Afficher les nœuds finaux et Afficher les données brutes pour utiliser cette API.

URL de la ressource

https://hostname:port/api/sam/unified/current/software?token=<token>

Syntaxe

GET /api/sam/unified/current/software?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ête
Content-Language
Valeurs
fr

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 Unified Software element
Format de réponse application/json
Codes de réponse

200 – OK

400 – "Bad Request" si un paramètre de requête contient des erreurs ou est manquant

Description de schéma

Pour extraire la liste de toutes les colonnes renvoyées par cette association, ainsi que leurs descriptions, utilisez la requête suivante :
GET /api/sam/unified/current/schemas/software.json?token=<token>

Colonnes disponibles

Tableau 2. Colonnes avec des informations sur le matériel informatique
Colonne Description Affichée par défaut Type
id Identificateur de l'instance de composant ou du package. ✓ Numérique
nom Nom du composant ou du package. ✓ Chaîne
lancement de préparation de commande édition du composant ou la version du package. ✓ Chaîne
detailed_version version détaillée de la version du composant ou du package. ✓ Chaîne
discoverable_guid Identificateur global unique (GUID) du composant ou sha1 du package. ✓ Chaîne
discoverable_family_guid GUID de famille du composant. Pour les packages, la valeur renvoyée est null. ✓ Chaîne
publisher_name éditeur de composant ou fournisseur de package. ✓ Chaîne
discovery_start Date et heure auxquelles le composant ou le package a été enregistré pour la première fois. L'heure est spécifiée dans le fuseau horaire GMT. ✓ Chaîne
discovery_path Chemin d'accès au dossier sous lequel le composant est installé. Pour les packages, la valeur renvoyée est null. ✓ Chaîne
source Type du logiciel :
  • 0 : instance de composant
  • 1 : Module Windows
  • 2 : Package Unix
 Numérique
computer.id ID de l'ordinateur sur lequel le logiciel est reconnu. ✓ Numérique
computer.name Nom de l'ordinateur sur lequel le logiciel est reconnu. ✓ Chaîne

Association applicable

Vous pouvez par ailleurs extraire des données des association d'ordinateurs.

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 : Extraire l'édition
URL?columns[]=name&columns[]=release
 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 les ID par ordre décroissant
URL?order[]=id desc
 Alphanumérique
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 Icône utilisateur et cliquer sur Profil. Cliquez ensuite sur Afficher le jeton. ✓ Alphanumérique
critères Extrayez 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-number> | <json-null>

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

Exemple : Extrayez une instance logicielle dont le nom contient "BigFix" ou dont la date de début de la reconnaissance se trouve dans une plage de dates spécifiques
URL?criteria={ "or": [ ["name", "contains", "BigFix"], 
{ "and": [ ["discovery_start", ">", "2018-10-01T00:00:00+00:00Z"], 
["discovery_start", "<", "2018-10-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.

Exemple : extraction des instances de logiciel signalées pour la première fois au cours des sept derniers jours
URL?criteria={"and":[["discovery_start","last","P7D"]]}
 Chaîne

Exemples de conversations

Pour passer en revue les packages Windows supprimés, utilisez l'API suivante :
GET api/sam/raw_package_facts?columns[]=name&columns[]=
is_supressed&columns[]=.comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Pour passer en revue les packages UNIX supprimés, utilisez l'API suivante :
GET api/sam/raw_unix_package_facts?columns[]=name&columns[]=
is_suppressed&columns[]=comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Pour passer en revue les instances logicielles supprimées, utilisez l'API suivante :
GET /api/sam/v2/software_instances?columns[]=component_name&columns[]
=component_release&columns[]=is_suppressed&columns[]=exclusion_or_suppress_comment&criteria=
{"and":[["is_suppressed","=",1]]}
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Pour afficher les données d'ordinateur associées, utilisez l'API suivante :
GET /api/sam/unified/current/software?columns[]=name&columns[]=release&columns[]
=computer.name&columns[]=computer.ip_address
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623