Extraction de l'utilisation des licences

Utilisez l'opération GET sur l'élément api/sam/license_usages pour demander des informations sur l'utilisation des licences signalée par vos systèmes informatiques.

Cette API extrait l'utilisation maximale des licences au cours des 90 derniers jours. L'utilisation des licences PVU et RVU en pleine capacité et en capacité partielle est extraite seulement au niveau du système informatique hôte. Pour extraire les informations sur l'utilisation des licences signalée par vos systèmes informatiques, utilisez l'URL suivante : 
https://hostname:port/api/sam/license_usages?token=token
Important :
  • Pour utiliser cette API, vous devez être affecté au groupe Tous les ordinateurs et disposer du droit Afficher les métriques de licence.
  • Chaque demande d'API doit être authentifiée avec le paramètre token. 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.
  • Cette API récupère les données des 90 derniers jours, jusqu'à la dernière importation réussie.
  • Par défaut, les données extraites sont triées via les colonnes computer_system_id, software_title_id et metric_name.
Tableau 1. Descriptions des opérations
Détails de l'opération Description
Fonctionnement GET /api/sam/license_usages
Finalité Renvoie des informations sur l'utilisation des licences
Méthode HTTP GET
URI de resources https://server_host_name:port_number/api/sam/license_usages
Relation du lien de l'URL n/a
Paramètres de requête URI Pour une liste de paramètres de requêtes applicables, voir : Paramètres de requête.
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.
En-tête
Import-Mode
Valeurs
none, idle, running, pending

Indique le statut de l'importation.
En-tête
Import-Progress
Valeurs
Une valeur en pourcentage, par exemple 59.

Indique la progression en pourcentage d'une importation.
En-tête
Import-Last-Status
Valeurs
successful, failed

Indique le statut de la dernière importation.
En-tête
Import-Last-Success-Time
Valeurs
Date, par exemple 2014-06-18T04:00:29Z.

Indique l'heure de la dernière importation réussie.
Charge de la réponse License Usages é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. Le tableau suivant présente les paramètres de requête que vous pouvez utiliser pour l'élément api/sam/license_usages.
Tableau 2. Paramètres de requête pour l'extraction de l'utilisation des licences
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 version :
URL?columns[]=name&columns[]=version
 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 décroissant par utilisation maximale des licences :
URL?order[]=peak_value desc
 Non Chaîne
limit Indiquez le nombre de lignes à extraire. Si vous omettez ce paramètre, toutes les lignes sont extraites. 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 : éxtrayez l'utilisation des licences pour les logiciels dont le nom d'éditeur contient "BigFix" :
URL?criteria={ "and": [ ["publisher_name", "contains", "BigFix"]]}

Exemple de conversation HTTP

Demande
GET api/sam/license_usages
?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
L'en-tête de réponse ci-dessus peut être suivi par différentes entrées, en fonction de l'état actuel de l'importation de données qui est représentée par Import-Mode. Pour comprendre les valeurs renvoyées, voir les définitions suivantes :
  • none - aucune importation de données n'a été initiée
  • idle - aucune importation de données ne s'exécute actuellement
  • running - une importation de données est en cours
  • pending - une action exécutée dans l'interface utilisateur nécessite le démarrage d'une importation de données pour que le changement prenne effet
Si aucune importation de données n'a été initiée :
Import-Mode: none
Si une importation de données est en cours :
Import-Mode: running
Import-Progress: 41
Si aucune importation de données n'est en cours d'exécution :
Import-Mode: idle/pending
Import-Last-Status: successful
Import-Last-Success-Time: Mon, 23 Jun 2014 12:18:29 GMT
Corps de réponse (JSON)
Si une entrée particulière est masquée par défaut, elle n'est pas extraite en cas d'utilisation de l'URL générale. Pour extraire ces données, vous devez utiliser les paramètres de requête pour spécifier le nom de la colonne masquée. Par exemple, vous pouvez extraire la colonne software_title_dimension.name en utilisant le paramètre columns[] : 
URL?columns[]=software_title_dimension.name
{
"software_title_id": 36181,
"metric_name": "RVU_FULL_CAP",
"computer_system_id": 4,
"peak_value": 1,
"peak_date": "2014-04-14",
"peak_time": "2014-04-14T13:05:10Z",
"reporting_period_start_date": "2014-04-01",
"reporting_period_end_date": "2014-04-30",
"software_title_dimension":   //hidden by default 
   {
   "name": "BigFix Protection",
   "guid": "d78048cf-842b-44e8-8036-e7e2bf8afb31",
   "publisher_name": "BigFix",
   "publisher_guid": "8a759f0c-b91a-4d7d-8c4a-a9d85e06c13d" 
   }
}