SDK de Python

Utilice el SDK de Python para empezar a utilizar rápidamente las API REST. Puede utilizar el SDK para los tipos de dispositivo que se han creado en versiones anteriores a 8.8. El SDK no se puede utilizar con tipos de dispositivo creados en la versión 8.8 o posterior.

Utilizando los módulos, puede interactuar con las API REST para:

  • Gestionar tipos de dispositivo
  • Gestionar dimensiones
  • Gestionar métricas
  • Gestionar constantes
  • Cargar datos de métrica

Módulos

Descripción Módulo Entrada Resultado Script
Leer los datos de métricas de un tipo de dispositivo existente load_metrics_data_from_csv Ninguno Carga de datos del script csv
Suprimir un tipo de dispositivo remove_entity_type Respuesta de API Eliminación de tipo de dispositivo, funciones, constantes, script de dimensiones
Añadir funciones de métrica (KPI) a un tipo de dispositivo add_functions Ninguno Creación de entidades, adición de funciones, constantes, script de dimensiones
Obtener todas las funciones de métrica (KPI) de un tipo de dispositivo get_functions Lista de dict con funciones de métrica (ICR) (respuesta de API) Obtención de funciones, constantes y script de dimensiones
Suprimir una función de métrica (KPI) de un tipo de dispositivo remove_function Respuesta de API Eliminación de tipo de dispositivo, funciones, constantes, script de dimensiones
Registrar una constante globalmente create_constants Respuesta de API Ninguno
Obtener todas las constantes de un arrendatario get_constants lista de dict con información de constantes (respuesta de API) Obtener funciones, constantes y script de dimensiones
Actualizar constantes para un arrendatario update_constants Respuesta de API Ninguno
Anular registro de constantes por nombre remove_constants Respuesta de API Ninguno
Añadir datos de dimensión a entidades add_dimensions_data Respuesta de API Creación de entidades, adición de funciones, constantes, script de dimensiones
Obtener todos los datos dimensionales de un tipo de dispositivo get_dimensions_data Lista de dict con información de datos de dimensión (respuesta de API) Obtención de funciones, constantes y script de dimensiones
Actualizar datos de dimensión update_dimensions_data Respuesta de API Ninguno
Suprimir una dimensión por nombre remove_dimensions
  • dimension_names: Lista de nombres de dimensión a suprimir
  • entity_type_name: Nombre del tipo de dispositivo en formato de serie
  • credentials: Consulte Adición de credenciales
 Respuesta de API Eliminación de tipo de dispositivo, funciones, constantes, script de dimensiones
Obtener todas las alertas utilizando una carga útil json get_alerts Respuesta de API Obtener alertas y actualizar el estado y el script de gravedad
Actualizar el estado de alerta utilizando el ID de alerta update_alert_status
  • alert_id: busque el ID de alerta utilizando el método get_alerts
  • new_status: Los valores disponibles son Nuevo, Reconocido, Resuelto y Omitido
  • credentials: Consulte Adición de credenciales
 Ninguno Ninguno
Actualizar la gravedad de alerta utilizando el ID de alerta update_alert_severity
  • alert_id Busque el ID de alerta utilizando el método get_alerts
  • new_status: Los valores disponibles son Baja, Media y Alta
  • credentials: Consulte Adición de credenciales
 Ninguno Ninguno

Instalación del SDK

Siga estos pasos para crear una copia del SDK de Python y ejecutarlo en el sistema local para fines de desarrollo y pruebas.

  1. Cree un entorno virtual
    python3 -m venv env
  2. Active el entorno virtual
    source env/bin/activate
  3. Instale el sdk desde GitHub
    pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git

En un entorno MAS OS X, si la base de datos de IBM (ibm_db) falla, siga estos pasos:

  1. Active el entorno virtual para configurar la variable $VIRTUAL_ENV
    source env/bin/activate
  2. Ejecute el mandato siguiente para descargar el controlador:
    pip install git+https://github.com/ibm-watson-iot/maximo-asset-monitor-sdk.git
  3. Ejecute el mandato siguiente una vez para arreglar el controlador:
    bash ./dev_resources/mac_ibmdb_fix.sh

Para obtener más información sobre el método alternativo, consulte https://github.com/ibmdb/python-ibmdb/issues/187#issuecomment-310765420