Extraction des composants logiciels (v2)

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

Droits

Icône représentant un utilisateur. Vous devez disposer du droit Afficher le catalogue des logiciels et les signatures pour effectuer cette tâche.

URL de la ressource

https://hostname:port/api/sam/v2/software_components?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
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 Software Components 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

9.2.10 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/software_component.json?token=<token>

Colonnes disponibles

Tableau 2. Colonnes disponibles
Colonne Description Affichée par défaut Type
id Identificateur de l'instance de composant. ✓ Numérique
nom Nom du composant. ✓ Chaîne
release version du composant. ✓ Chaîne
guid Identificateur global unique du composant. ✓ Chaîne
is_ibm Informations indiquant si le composant est un composant logiciel IBM. ✓ Valeur boléenne

Associations applicables

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

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 l'ID du composant
URL?columns[]=name&columns[]=id
 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 par ID composant et 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 é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-number> | <json-null>

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

 Chaîne

Exemple de conversation - Colonne par défaut

Demande
GET api/sam/v2/software_components?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"id":1,
"name":"DB2 8.1",
"release":8,
"guid":"XYZ",
"is_ibm":1,
}]

Exemple de conversation - Association

Demande
GET api/sam/v2/software_components?columns[]=id&columns[]=name
&columns[]=tags.name
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"id":1,
"name":"DB2 8.1",
"tags":
[{"name":"ibm"}]
}]