éléments courants des API REST

Vous utilisez des connecteurs et opérateurs pour générer des segments de requêtes qui filtrent les conditions et valeurs correspondantes.

Connecteurs

Tableau 1. Connecteurs
Connecteur Description
and Ajouter toutes les propositions avec un concaténateur and
or Ajouter toutes les propositions avec un concaténateur or

Paramètres

Tableau 2. Paramètres
Paramètre Description
countSwitch Indique si la requête renvoie les données demandées, le nombre de lignes extraites, ou les deux. L'opérateur peut avoir les valeurs suivantes :
  • 1 - Seules les données demandées sont renvoyées
  • 2 - Seul le nombre de lignes est renvoyé
  • Aucune valeur ou toute autre valeur - Les données demandées et le nombre de lignes sont renvoyés

Opérateurs

Tableau 3. Opérateurs
Opérateur Description Applicable à
= égal à.
!= Différent de.
< Inférieur à. Zone numérique ou de date uniquement.
<= Inférieur ou égal à. Zone numérique ou de date uniquement.
> Supérieur à. Zone numérique ou de date uniquement.
>= Supérieur ou égal à. Zone numérique ou de date uniquement.
last Période de temps relative passée (par exemple, les 7 derniers jours). Zones de date et d'heure uniquement.
next Période relative passée (par exemple, les 7 derniers jours). Zones de date et d'heure uniquement.
starting Période de temps relative qui commence dans le passé ou dans le futur (par exemple, il y a 7 jours ou dans 7 jours) et qui durera infiniment. Pour connaître la syntaxe, voir Opérateurs de date et d'heure relatives. Zones de date et d'heure uniquement.
ending Période de temps relative qui se termine dans le passé ou dans le futur (par exemple, il y a 7 jours ou dans 7 jours) et incluant toutes les données jusqu'à ce point. Pour connaître la syntaxe, voir Opérateurs de date et d'heure relatives. Zones de date et d'heure uniquement.
begins_with La chaîne commence par la valeur spécifiée. Zones de type chaîne uniquement.
not_begins_with La chaîne ne commence pas par la valeur spécifiée. Zones de type chaîne uniquement.
contains La chaîne contient la valeur spécifiée. Zones de type chaîne uniquement.
not_contains La chaîne ne contient pas la valeur spécifiée. Zones de type chaîne uniquement.
ends_with La chaîne se termine par la valeur spécifiée. Zones de type chaîne uniquement.
not_ends_with La chaîne ne se termine pas par la valeur spécifiée. Zones de type chaîne uniquement.
9.2.13 is_empty La colonne ne contient aucune valeur.
Exemple :
  • https://hostname:port/api/sam/v2/software_instances?token=token
&criteria={"and":[["exclusion_or_suppress_comment","is_empty"]]}
 Colonnes sélectionnées uniquement.
9.2.13 is_not_empty La colonne contient une valeur.
Exemple :
  • https://hostname:port/api/sam/v2/software_instances?token=token
&criteria={"and":[["exclusion_or_suppress_comment","is_not_empty"]]}
 Colonnes sélectionnées uniquement.

Syntaxe des opérateurs de date et d'heure relatives

Ces opérateurs sont utilisables pour toutes les colonnes utilisant le format de date et d'heure.
Remarque : Cette API de contrat s'applique aux anciens contrats (contrats obsolètes). Les nouveaux contrats n'utilisent pas cette API. Pour plus d'informations sur les nouveaux contrats, voir Gestion des nouveaux contrats.
Tableau 4. Opérateurs de date et d'heure relatives
Opérateur Syntaxe

last next

 Px[D|W|M|Y]
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. Par exemple :
  • éxtraire les données des ordinateurs signalés dans les 7 derniers jours :
    https://hostname:port/api/sam/computer_systems?token=token
&criteria={"and":[["last_seen","last","P7D"]]}
  • éxtraire les contrats dont l'autorisation d'utilisation prend fin dans les 7 prochains jours :
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["entitlement_end","next","P7D"]]}

starting ending

 [-|+]Px[D|W|M|Y]
où x est un nombre compris entre 1 et 999, -/+ représente "il y a" ou "jusqu'à" et D, W, M ou Y est un identificateur qui représente les jours, semaines, mois ou années, respectivement. Par exemple :
  • éxtraire les contrats dont la maintenance commence dans une période débutant dans une semaine. Cette API n'extrait que les futurs contrats.
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["maintenance_start","starting","+P1W"]]}
  • éxtraire les contrats dont l'autorisation d'utilisation se termine dans une période qui a pris fin il y a 1 jour. Cette API extrait tous les contrats possibles du passé jusqu'au jour précédent :
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["entitlement_end","ending","-P1D"]]}

éléments de réponse pour les demandes GET

Tableau 5. éléments de réponse pour les demandes GET
élément Description
total Nombre total d'enregistrements qui répondent au paramètre de requête. Le nombre d'enregistrements renvoyés peut être plus faible, par exemple si vous utilisez le paramètre limit.
rows Enregistrements qui sont renvoyés par la requête.