REST API - Voir tous les liens impactés par un CI


Version minimum : Service Manager 2016 - Build 2016.1.321.0

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

  • Cette méthode permet d’obtenir tous les liens impactés par un élément de configuration (CI) déterminé (liste des CI dont l'indisponibilité résulte de l'indisponibilité du CI courant).
           exemple   /configuration-items/123/item-links/impacted
  • Pour obtenir :
    • tous les liens impactant un CI déterminé (liste des CI dont l'indisponibilité entraîne l'indisponibilité du CI courant) : GET  /configuration-items/{ci_id}/item-links/impacting  - Open url.png voir la méthode
    • tous les liens (impactants / impactés) d'un CI déterminé : GET  /configuration-items/{ci_id}/item-links  - 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 le corps de la requête HTTP, vous devez utiliser les objets JSON ci-dessous.

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

Paramètres optionnels

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

exemple /configuration_items/123/items_links/impacted?linked_ci=456

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 avec un code de statut retourné 200

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


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 2020/03/30 11:38
Créé par Administrator XWiki le 2019/06/28 09:31

Raccourcis

L'actualité mensuelle
•  Newsletter

Tous les changements
•  Service Manager
•  Service Apps
•  Self Help

Glossaire

Powered by XWiki ©, EasyVista 2020