copyright	lastupdated
years 2017, 2019	2019-06-18

{:new_window: target="_blank"} {:shortdesc: .shortdesc} {:screen: .screen} {:codeblock: .codeblock} {:pre: .pre} {:child: .link .ulchildlink} {:childlinks: .ullinks}

Maximo Asset Monitor Python SDK

{: #python .reference}

Use the Python SDK to get started quickly with using the REST APIs of Maximo Asset Monitor. {:shortdesc}

Using the modules, you can interact with the REST APIs to:

• Manage entity types
• Manage dimensions
• Manage KPI functions
• Manage constants
• Load metric data

Modules

{: #modules .sectiontitle}

Description	Module	Input	Output	Script
Create an entity type using json payload	create_custom_entity_type	json_payload: See sample payload credentials : See Adding credentials **kwargs { drop_existing: Delete existing table and rebuild the entity type table in the database db_schema: If no schema is provided, use the default schema }	None	Creating entities, adding functions, constants, dimensions script
Read metric data for an existing entity type	load_metrics_data_from_csv	entity_type_name: Name of entity type in string format file_path: Path to the file credentials: See Adding credentials	None	Loading data from csv script
Delete an entity type	remove_entity_type	entity_type_name: Name of entity type in string format credentials: See Adding credentials	API response	Removing entity type, functions, constants, dimensions script
Add KPI functions to an entity type	add_functions	json_payload: See sample payload credentials: See Adding credentials	None	Creating entities, adding functions, constants, dimensions script
Get all of the KPI functions of an entity type	get_functions	credentials: See Adding credentials entity_type_name: Name of entity type in string format	List of dict with KPI functions (API response)	Getting functions, constants, and dimensions script
Delete a KPI function of an entity type	remove_function	credentials: See Adding credentials entity_type_name: Name of entity type in string format kpi_name Name of KPI function in string format credentials: See Adding credentials	API response	Removing entity type, functions, constants, dimensions script
Register a constant globally	create_constants	json_payload: See sample payload credentials: See Adding credentials	API response	None
Get all of constants for a tenant	get_constants	entity_type_name Name of entity type in string format credentials: See Adding credentials	list of dict with constants information (API response)	Get functions, constants, and dimensions script
Update constants for a tenant	update_constants	json_payloadSee sample payload credentials: See Adding credentials	API response	None
Unregister constants by name	remove_constants	constant_names: List of constant names to delete credentials: See Adding credentials	API response	None
Add dimension data to entities	add_dimensions_data	json_payload: See sample payload credentials: See Adding credentials	API response	Creating entities, adding functions, constants, dimensions script
Get all the dimensional data for an entity type	get_dimensions_data	entity_type_name Name of entity type in string format credentials: See Adding credentials	List of dict with dimension data information (API response)	Getting functions, constants, and dimensions script
Update dimension data	update_dimensions_data	json_payload: See sample payload credentials: See Adding credentials	API response	None
Delete a dimension by name	remove_dimensions	dimension_names: List of dimension names to delete entity_type_name: Name of entity type in string format credentials: See Adding credentials	API response	Removing entity type, functions, constants, dimensions script
Get all alerts using a json payload	get_alerts	json_payload: See sample payload credentials: See Adding credentials	API response	Get alerts and update status and severity script
Update the alert status using the alert ID	update_alert_status	alert_id: Find the alert ID using the get_alerts method new_status: Available values are New, Acknowledged, Resolved, and Dismissed credentials: See Adding credentials	None	None
Update the alert severity using alert ID	update_alert_severity	alert_id Find the alert ID using the get_alerts method new_status: Available values are Low, Medium, and High credentials: See Adding credentials	None	None

Installing the SDK

{: #install .sectiontitle}

Complete these steps to create a copy of the Python SDK and run it on your local system for development and testing purposes.

1. Create a virtual environment

   python3 -m venv env
   

2. Activate virtual environment

   source env/bin/activate
   

3. Install sdk from GitHub

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

On a MAS OS X environment, if the IBM database (ibm_db) fails, complete these steps:

1. Activate the virtual environment to set up the $VIRTUAL_ENV variable

   source env/bin/activate
   

2. Run the following command to download the driver:

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

3. Run the following command once to fix the driver:

   bash ./dev_resources/mac_ibmdb_fix.sh
   

For more information about the workaround, see ibmdb/python-ibmdb#187 (comment)

Adding credentials to your script

{: #save-your-credentials-to-a-file .sectiontitle}

Important: The credentials file is used to run or test functions locally. Do not push this file to any external repository.

1. Set credentials to connect to Analytics Service.
   1. Create a credentials.json file in the scripts folder in your working directory.
   2. On the user interface, go to the Services tab.
   3. Select Watson IoT Platform Analytics and click View Details.
   4. In the Environment Variables field, click Copy to Clipboard.
   5. Paste the contents of the clipboard into the credentials.json file.
2. Load your credentials in your script. Add the following code to your script:

   credentials_path=<path to credentials.json>
   with open(credentials_path, 'r') as F:
       credentials = json.load(F)