REST API - Voir une liste de CI

Modifié le 08/11/2022 13:22
Sommaire

GET  /configuration-items

  • Pour obtenir les informations détaillées d'un CI déterminé : GET /configuration-items/{ci_id}  - Open url.png voir la méthode

Remarques

       Open url.png  voir Conventions de l'API REST Service Manager

  • En cas de succès, un code de statut HTTP 200 est retourné.
    • Par défaut, si le paramètre optionnel fields n’est pas utilisé, seul un extrait des champs les plus utiles sélectionnés par EasyVista est affiché pour chaque enregistrement fourni.
    • Un lien URL (HREF) vers chaque ressource est fourni permettant d'obtenir la liste complète des champs pour un enregistrement.

Liste des paramètres / champs

Paramètres obligatoires

Aucun

Paramètres optionnels

Dans la chaîne de requête HTTP, vous pouvez utiliser les paramètres détaillés ci-dessous.

Version minimum Paramètre Type Description / Exemple
max_rows integer Nombre maximal d’enregistrements à afficher.
  • Valeur par défaut : 100
  • exemple /configuration-items?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /configuration-items?sort=installation_date+desc
fields string Sélection de champs à afficher.
  • exemple /configuration-items?fields=network_identifier,asset_tag,serial_number
search string Recherche/filtre sur des champs définis   -   Open url.png voir ?search=Description des options
  • exemple /configuration-items?search=asset_tag~"ZS_*"

Une recherche sur un champ Date est aussi possible.

  • exemple /configuration-items?search=last_integration:this_year
Oxygène 2.1.2 - Build 2018.1.183.0 search

(opérateur logique OU)

 string Recherche/filtre sur plusieurs valeurs d'un même champ
  • Syntaxe : search=champ:valeur1,champ:valeur2
  • exemple
    • /configuration-items?search=ci_status_id:1,ci_status_id:2 ==> tous les CI dont le statut est 1 ou 2
Oxygène 1.7 - Build 2018.1.131.0 ~

(équivalent à like)

 string Inclure tous les résultats commençant par ou contenant une chaîne de caractères donnée
  • Syntaxe : ~ suivi de la chaîne à inclure, placée entre guillemets
  • Utilisez le caractère joker *.
    • < chaîne >* = inclure ce qui commence par < chaîne >
    • *< chaîne >* = inclure ce qui contient < chaîne >
  • exemple
    • /configuration-items?search=network_identifier~"BDD*" ==> tous les CI dont le champ network_identifier commence par BDD
    • /configuration-items?search=network_identifier~"*BDD*" ==> tous les CI dont le champ network_identifier contient BDD
Oxygène 1.7 - Build 2018.1.131.0 !~

(équivalent à not like)

 string Exclure tous les résultats commençant par ou contenant une chaîne de caractères donnée
  • Syntaxe : !~ suivi de la chaîne à exclure, placée entre guillemets
  • Utilisez le caractère joker *.
    • < chaîne >* = exclure ce qui commence par < chaîne >
    • *< chaîne >* = exclure ce qui contient < chaîne >
  • exemple
    • /configuration-items?search=network_identifier!~"BDD*" ==> tous les CI en excluant ceux dont le champ network_identifier commence par BDD
    • /configuration-items?search=network_identifier!~"*BDD*" ==> tous les CI en excluant ceux dont le champ network_identifier contient BDD
Oxygène 1.7 - Build 2018.1.131.0 !

(équivalent à not)

 string Exclure tous les résultats égaux à une chaîne de caractères donnée
  • Syntaxe : ! suivi de la chaîne à exclure, placée entre guillemets
  • exemple /configuration-items?search=network_identifier!"BDD-SQL-FR*" ==> tous les CI en excluant ceux dont le champ network_identifier est égal à BDD-SQL-FR*
Oxygène 2.1.2 - Build 2018.1.183.0 is_null string Remonter tous les résultats pour lesquels les valeurs du champ sont vides (valeur du champ = null)
  • Syntaxe : Nom du champ suivi de "is_null"
  • exemple
    • /configuration-items?search=ci_version:"is_null" ==> tous les CI pour lesquels le champ ci_version est vide
    • /configuration-items?search=ci_version:"is_null",status_ci_id:1&sort=asset_id+asc ==> uniquement les CI dont le statut est égal à 1 et pour lesquels le champ ci_version est vide, triés par identifiant croissant
Oxygène 2.1.2 - Build 2018.1.183.0 is_not_null string Remonter tous les résultats pour lesquels les valeurs du champ sont non vides (valeur du champ = not null)
  • Syntaxe : Nom du champ suivi de "is_not_null"
  • exemple
    • /configuration-items?search=ci_version:"is_not_null" ==> tous les CI pour lesquels le champ ci_version n'est pas vide
    • /configuration-items?search=ci_version:"is_not_null",status_ci_id,&sort=asset_id+asc ==> uniquement les CI dont le statut est égal à 1 et pour lesquels le champ ci_version n'est pas vide, triés par identifiant croissant
Oxygène 1.7 - Build 2018.1.131.0 formatDate string Formater l’affichage des champs de type Date dans le résultat de la requête HTTP   -   Open url.png voir Description des options de formatage
  • exemple
    • /configuration-items?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /configuration-items?fields=last_update&formatDate=l jS \of F Y h:i:s A ==> "last_update_format": "Friday 16th of November 2018 12:00:00 AM"

Champs pouvant être utilisés pour les paramètres optionnels

Vous pouvez utiliser tous les champs de la table AM_ASSET.

Codes de statut HTTP de la méthode

StatusHeader

Note : Un code erreur Timeout est renvoyé et la méthode échoue si le serveur ne répond pas à la requête du web service REST au bout d'un certain temps (par défaut, 60 secondes).

Code Erreur Description
Status200
200 OK (Succès) Requête traitée avec succès.
Status401
401 Unauthorized (Non autorisé) Processus d'authentification pour accéder à la ressource incorrect : Login/Mot de passe incorrect, Session non valide, Compte Service Manager incorrect.

exemple

{
 "error": "Invalid Login / Password"
}

Exemple

Résultat pour 3 CI (code de statut 200)

{
 "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items?search=asset_tag~%22ZS%2A%22",
 "record_count": "10",
 "total_record_count": "3",
 "records": [
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/18782",
     "ASSET_ID": "18782",
     "ASSET_TAG": "ZS_002",
     "CI_STATUS_ID": "1",
     "CI_VERSION": "10.3.1",
     "NETWORK_IDENTIFIER": "BDD-SQL-FR*"
    },
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/18787",
     "ASSET_ID": "18787",
     "ASSET_TAG": "ZS_001",
     "CI_STATUS_ID": "1",
     "CI_VERSION": " -",
     "NETWORK_IDENTIFIER": "SRV_12-F"
    },
    {
     "HREF": "https://{your_server}/api/v1/{your_account}/assets/18799",
     "ASSET_ID": "18799",
     "ASSET_TAG": "ZS_006",
     "CI_STATUS_ID": "1",
     "CI_VERSION": " -",
     "NETWORK_IDENTIFIER": "SRV_OFF1"
    },
  ]
}
ConventionsAPI

Conventions de l'API REST

Convention Signification
Orange Paramètres utilisés dans la chaîne d’une requête HTTP et qui ne correspondent pas à des champs de la base Service Manager.

exemple   Méthode Voir une liste de biens

https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag
Noir et Gras Paramètres utilisés dans l’URL d’une requête HTTP et qui correspondent à des champs de la base Service Manager.

exemple   Méthode Voir un bien

https://{your_server}/api/v1/{your_account}/assets/{asset_id}
Vert Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON correspondant à des champs de la base Service Manager ; ils permettent d’affecter ou de modifier une valeur de champ dans la base.

exemple   Méthode Terminer un ticket

{  "closed": {  "end_date": "11/20/2016 12:12:12",  }  }
Paramètres utilisés dans le corps d’une requête HTTP et qui représentent des noms d’objets JSON ne correspondant pas à des champs de la base Service Manager.

exemple   Méthode Reprendre un ticket

{  "restarted": {  "comment": "string (required)"  }  }
Tags :
Powered by XWiki © EasyVista 2022