SDK Python

Utilisez le SDK Python pour vous initier rapidement à l'utilisation des API REST. Vous pouvez utiliser le SDK pour les types d'appareil qui ont été créés dans des versions antérieures à 8.8. Le SDK ne peut pas être utilisé avec des types d'appareil qui ont été créés dans la version 8.8 ou ultérieure.

A l'aide des modules, vous pouvez interagir avec les API REST pour :

Gérer les types de terminaux
Gérer les dimensions
Gérer les métriques
Gérer les constantes
Charger les données de métrique

Modules

Description	Module	Entrée	Sortie	Script
Lecture des données de mesure pour un type d'unité existant	load_metrics_data_from_csv	`entity_type_name`: nom du type d'unité au format chaîne `file_path`: chemin d'accès au fichier `credentials`: Voir Ajout de données d'identification	Aucun	Chargement de données à partir du script csv
Suppression d'un type d'unité	remove_entity_type	`entity_type_name`: nom du type d'unité au format chaîne `credentials`: Voir Ajout de données d'identification	Réponse d'API	Suppression du type d'unité, de fonctions, de constantes, du script de dimensions
Ajouter des fonctions d'unité de mesure (KPI) à un type de périphérique	add_functions	`json_payload`: Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Aucun	Création d'entités, ajout de fonctions, de constantes, de scripts de dimensions
Obtention de toutes les fonctions d'unité de mesure (KPI) d'un type de périphérique	get_functions	`credentials`: Voir Ajout de données d'identification `entity_type_name`: nom du type d'unité au format chaîne	Liste des fonctions de dictionnaire avec unité de mesure (KPI) (réponse d'API)	Obtention de fonctions, de constantes et du script de dimensions
Suppression d'une fonction d'unité de mesure (KPI) d'un type de périphérique	remove_function	`credentials`: Voir Ajout de données d'identification `entity_type_name`: nom du type d'unité au format chaîne `kpi_name` Nom de la fonction de métrique (KPI) au format chaîne `credentials`:Voir Ajout de données d'identification	Réponse d'API	Suppression du type d'unité, de fonctions, de constantes, du script de dimensions
Enregistrer une constante au niveau mondial	create_constants	`json_payload`: Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Réponse d'API	Aucun
Obtenir toutes les constantes d'un titulaire	get_constants	`entity_type_name`: nom du type d'unité au format chaîne `credentials`: Voir Ajout de données d'identification	Liste de dict avec informations sur les constantes (réponse d'API)	Obtention de fonctions, de constantes et du script de dimensions
Mettre à jour les constantes d'un titulaire	update_constants	`json_payload`Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Réponse d'API	Aucun
Annuler l'enregistrement de constantes par nom	remove_constants	`constant_names` : liste des noms de constante à supprimer `credentials`: Voir Ajout de données d'identification	Réponse d'API	Aucun
Ajouter des données de dimension à des entités	add_dimensions_data	`json_payload`: Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Réponse d'API	Création d'entités, ajout de fonctions, de constantes, de scripts de dimensions
Obtenir toutes les données dimensionnelles d'un type d'unité	get_dimensions_data	`entity_type_name`: nom du type d'unité au format chaîne `credentials`: Voir Ajout de données d'identification	Liste de dict avec informations sur les données de dimension (réponse d'API)	Obtention de fonctions, de constantes et du script de dimensions
Mettre à jour les données de dimension	update_dimensions_data	`json_payload`: Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Réponse d'API	Aucun
Supprimer une dimension par nom	remove_dimensions	`dimension_names` : liste des noms de dimension à supprimer `entity_type_name`: nom du type d'unité au format chaîne `credentials`: Voir Ajout de données d'identification	Réponse d'API	Suppression du type d'unité, de fonctions, de constantes, du script de dimensions
Obtenir toutes les alertes à l'aide d'un content JSON	get_alerts	`json_payload`: Voir l'exemple de contenu `credentials`: Voir Ajout de données d'identification	Réponse d'API	Obtenir les alertes et mettre à jour le statut et le script de gravité
Mettre à jour le statut alerte à l'aide de l'ID d'alerte	update_alert_status	`alert_id` : recherchez l'ID d'alerte à l'aide de la méthode get_alerts `new_status` : les valeurs disponibles sont New, Acknowledged, Resolved et Dismissed `credentials`: Voir Ajout de données d'identification	Aucun	Aucun
Mettre à jour la gravité des alertes à l'aide de l'ID d'alerte	Update_alert_severity	`alert_id` Recherchez l'ID d'alerte à l'aide de la méthode get_alerts `new_status` : les valeurs disponibles sont Low, Medium et High `credentials`: Voir Ajout de données d'identification	Aucun	Aucun

Installation du logiciel SDK

Exécutez les étapes suivantes pour créer une copie du logiciel SDK Python et l'exécuter sur votre système local à des fins de développement et de test :

Créez un environnement virtuel.
```
python3 -m venv env
```
Activez l'environnement virtuel.
```
source env/bin/activate
```

Installez le logiciel SDK à partir de GitHub.

pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git

Sur un environnement MAS OS X, si la base de données IBM (ibm_db) échoue, procédez comme suit :

Activer l'environnement virtuel pour configurer la variable $VIRTUAL_ENV
```
source env/bin/activate
```

Exécutez la commande suivante pour télécharger le pilote :

pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git

Exécutez la commande suivante une fois pour corriger le pilote :
```
bash ./dev_resources/mac_ibmdb_fix.sh
```

Pour plus d'informations sur la solution palliative, voir https://github.com/ibmdb/python-ibmdb/issues/187#issuecomment-310765420