Maximo Asset Monitor REST APIs

Use the Maximo Asset Monitor REST API endpoints to manage your entities, devices, or assets for your tenant.

Add dimensional data to describe your entities.

Manage your catalog of built-in and custom functions. Manage KPIs or data items that are configured using these functions. Manage constants and grain definitions that are reused or referenced across multiple functions.

Associate images with entity types for use in image cards on summary dashboards and device dashboards. Associate images with assets for display on image dashboards. Retrieve metadata of these images.

Query raw or aggregated metric data either for entity types or entities.

API endpoints

The following endpoints are available:

• Manage entity types: Retrieve, create, update, restore, and archive entity types.
• Manage dimensions: Retrieve, create, update, and delete dimensions (see Adding dimensions).
• Query metric data by device type: Query raw and aggregated metric data for a device type.
• Query metric data by device: Query raw and aggregated metric data for a device.
• Manage the function catalog: Add, update, and remove functions.
• Manage grains: Retrieve, add, update, and delete grains.
• Manage KPIs: Retrieve, create, update, or delete KPIs or data items.
• Manage constants: Retrieve, create, or update constants.
• Manage images by device type: Add, update, retrieve, or delete images for a device type (see Adding images).
• Manage images by device (see Adding images): Add, update, retrieve, or delete images for a device (see Adding images).

Authentication

Gather API information. Complete these steps:

1. Find the API key and token for the Analytics Service.
   1. From the user interface, go to the Services tab.
   2. Select Watson IoT Platform Service.
   3. Click View Details.
   4. Click View more.
   5. Save the API key and token for use.
2. Find your tenant name. Your tenant name is provided in each endpoint URL.

Important: Use the API key and token method to authorize your call to the API. Basic authorizaton is for internal use.

Service endpoints

The URL that is used for the service endpoint defines the protocol and environment where the API call is placed. Use the following URL in your service requests: http://api-{{geo_country_code}}.connectedproducts.internetofthings.ibmcloud.com/api

Where {{geo_country_code}} is the country code for your geography. In a production environment, valid values are us, uk, or de. If you are in a beta environment, use beta as the country code.

To access the swagger documentation, use the following URL: https://api-{{geo_country_code}}.connectedproducts.internetofthings.ibmcloud.com/openapi/ui/

For example: https://api-beta.connectedproducts.internetofthings.ibmcloud.com/openapi/ui/

Related information

• Maximo Asset Monitor Python SDK
• Platform Service REST APIs