REST API - Voir une liste de liens d'un CI


GET  /configuration-items/{ci_id}/item-links

  • Cette méthode permet d’obtenir une liste de liens d'un élément de configuration (CI) déterminé.
             exemple    /configuration-items/18782/item-links
  • Pour obtenir les informations détaillées d'un lien déterminé d'un CI déterminé : GET  /configuration-items/{parent_ci_id}/item-links/{child_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é.
    • 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

Dans l'URL, vous devez utiliser le paramètre ci-dessous.
 

Paramètre Type Description / Exemple
ci_id integer Identifiant du CI

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/18782/item-links?max_rows=5
sort string Tri ascendant ou descendant.
  • Syntaxe : field1[+asc|+desc],field2[+asc|+desc],fieldn[+asc|+desc]
  • exemple /configuration-items/18782/item-links?sort=child_ci_id+asc
fields string Sélection de champs à afficher.
  • exemple /configuration-items/18782/item-links?fields=child_ci_id
search string Recherche/filtre sur des champs définis   -   Open url.png voir Description des options
  • exemple /configuration-items?search=employee.e_mail:btalma@itactionservices.com

Une recherche sur un champ Date est aussi possible.

  • exemple /configuration-items/18782/item-links?search=last_integration:last_week
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/18782/item-links?search=relation_type_id:129,relation_type_id:130 ==> tous les liens du CI spécifié dont le champ relation_type_id est 129 ou 130
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/18782/item-links?search=parent_ci_id~"187*" ==> tous les liens du CI spécifié dont le champ parent_ci_id commence par 187
    • /configuration-items/18782/item-links?search=parent_ci_id~"*187*" ==> tous les liens du CI spécifié dont le champ parent_ci_id contient 187
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/18782/item-links?search=parent_ci_id!~"187*" ==> tous les liens du CI spécifié dont le champ parent_ci_id commence par 187
    • /configuration-items/18782/item-links?search=parent_ci_id!~"*187*" ==> tous les liens du CI spécifié dont le champ parent_ci_id contient 187
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/18782/item-links?search=parent_ci_id!"18782" ==> tous les liens du CI spécifié en excluant ceux dont le champ dont le champ parent_ci_id est égal à 18782
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/18782/item-links?search=parent_ci_id:"is_null" ==> tous les liens du CI spécifié pour lesquels le champ parent_ci_id est vide
    • /configuration-items/18782/item-links?search=parent_ci_id:"is_null",status_ci_id:1&sort=asset_id+asc ==> uniquement les liens d'un CI dont le statut est égal à 1 et pour lesquels le champ parent_ci_id 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/18782/item-links?search=parent_ci_id:"is_not_null" ==> tous les liens du CI spécifié pour lesquels le champ parent_ci_id n'est pas vide
    • /configuration-items/18782/item-links?search=parent_ci_id:"is_not_null",status_ci_id:1&sort=asset_id+asc ==> uniquement les liens d'un CI dont le statut est égal à 1 et pour lesquels le champ parent_ci_id 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/18782/item-links?fields=last_update&formatDate=l/M/Y ==> "last_update_format": "Friday/Nov/2018"
    • /configuration-items/18782/item-links?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
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"
}
Status404
404 Not found (Non trouvée) Ressource non trouvée : URI incorrecte, Ressource inexistante, Communication avec le serveur incorrecte, rfc_number non trouvé.

exemple

{
 "error": "Resource not found"
}

Exemple

Résultat pour 4 liens d'un CI (code de statut 200)

{
   "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782/item-links",
   "record_count": "4",
   "total_record_count": "4",
   "records": [
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "hhttps://{your_server}/api/v1/{your_account}/configuration-items/48716",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48716",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/48718",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48718",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/48723",
           "BLOCKING": "1",
           "CHILD_CI_ID": "48723",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        },
        {
           "PARENT_HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/18782",
           "HREF": "https://{your_server}/api/v1/{your_account}/configuration-items/49182",
           "BLOCKING": "1",
           "CHILD_CI_ID": "49182",
           "PARENT_CI_ID": "18782",
           "RELATION_TYPE_ID": "129",
           "RELATION_TYPE": {
               "REFERENCE_FR": "Base de données",
               "REFERENCE_ID": "129"
            }
        }
    ]
}


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:
Modifié par Utilisateur inconnu le 2021/02/05 17:38
Créé par Administrator XWiki le 2017/12/21 08:53

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements

•  Service Manager
•  Service Apps
•  Self Help
•  Service Bots

Powered by XWiki ©, EasyVista 2021