Service Web de tableaux de bord

Les services Web de l'API de CA npc permettent aux administrateurs d'effectuer les tâches de gestion des tableaux de bord.
capm250
Les services Web de l'API de CA
NetOps Portal
permettent aux administrateurs d'effectuer les tâches de gestion des tableaux de bord.
Le service Web RESTful de tableaux de bord permet de créer et de gérer des pages de tableau de bord pour afficher des vues de données.
  • Créez de nouveaux tableaux de bord.
  • Importation et exportation de tableaux de bord
  • Créez les tableaux de bord, puis déployez-les dans un client hébergé supplémentaire. La fonctionnalité d'importation vous permet de déployer des tableaux de bord supplémentaires sans les recréer manuellement.
Pour importer un tableau de bord pour un client hébergé, connectez-vous en tant qu'administrateur pour ce client hébergé.
Si vous exportez un tableau de bord au format XML via le service Web RESTful, il peut se détériorer une fois publié au format XML. Pour éviter ce problème, créez un tableau de bord en copiant l'un de ceux inclus dans l'interface utilisateur. Pour plus d'informations, consultez la section Gestion des tableaux de bord.
Envoyez l'appel suivant pour afficher les paramètres du service Web de tableaux de bord :
http://
PC_host
:8181/pc/center/rest/dashboards/documentation
Exportation d'un tableau de bord
Effectuez une opération GET pour exporter un tableau de bord dans un fichier XML approprié pour l'importation dans une autre instance de CAPC.
Pour exporter un tableau de bord, l'ID de page interne affecté est requis. Utilisez l'interface utilisateur du produit pour trouver l'ID :
  1. Accédez au tableau de bord à exporter.
  2. Dans la fenêtre du navigateur, recherchez l'ID de page dans l'URL.
    Exemple :
    http://
    PC_host
    :8181/pc/desktop/page?pg=2000040
    L'ID de page est 2000040.
  3. Dans un client REST, définissez l'URL comme suit :
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/pageId
  4. Effectuez une opération GET.
    Un message d'erreur ou de confirmation de l'opération s'affiche dans la réponse.
Importation d'un tableau de bord
Vous pouvez importer un tableau de bord à partir d'un fichier XML.
  1. Accédez au fichier XML qui représente le tableau de bord exporté et sélectionnez-le, ou collez le texte exporté du fichier XML dans le champ Corps.
  2. Mettez à jour les attributs dashboardMenu, menuItem et dashboardTitle dans le corps du XML pour le tableau de bord que vous importez :
    <dashboardMenu>MyCustomDashboard_DashboardMenuName</dashboardMenu> <menuItem>MyCustomDashboard_MenuItemName</menuItem> <dashboardTitle>MyCustomDashboard_DashboardTitleName</dashboardTitle>
    • <dashboardMenu>
      Titre qui s'affiche dans la partie supérieure du menu du tableau de bord. Spécifiez un titre de menu de tableau de bord de niveau supérieur existant pour cet attribut.
      Exemples :
      Intégrité de l'infrastructure, Planification de la capacité.
    • <menuItem>
      Titre du tableau de bord qui s'affiche dans le menu Tableaux de bord. Cette propriété est unique pour chaque client hébergé.
    • <dashboardTitle>
      Titre du tableau de bord qui s'affiche en haut de la page de tableau de bord. Cette propriété est unique pour chaque client hébergé.
  3. (Facultatif) Tester l'importation d'un tableau de bord avant de l'importer.
    Effectuez l'opération POST suivante :
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/test/
    Le message suivant s'affiche pour indiquer que le test a réussi :
    <?xml version="1.0" encoding="UTF-8"?>
    <msg>Validation successful.</msg>
    La vérification est effectuée pour les attributs uniques menuItem et dashboardTitle.
  4. Définissez l'URL comme suit :
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/import
  5. Effectuez une opération POST.
  6. Un message d'erreur ou de confirmation de l'opération s'affiche dans la réponse.
    Le service Web assigne un ID de page au tableau de bord importé.
Mise à jour d'un tableau de bord
Vous pouvez mettre à jour un tableau de bord à partir d'un ID de page. Pour modifier le tableau de bord, modifiez le fichier XML :
  1. Définissez l'URL comme suit :
    http://
    PC_host
    :8181/pc/center/webservice/dashboards/pageId
  2. Collez le fichier XML qui représente le tableau de bord dans le champ Corps et modifiez le fichier XML, selon vos besoins.
  3. Effectuez une opération PUT.
    Un message d'erreur ou de confirmation de l'opération s'affiche dans la réponse.