Endpoint attribute substitution variables

Some endpoints in the IoT Connector wizard include attribute substitution variables. It is important to understand the function of these variables and how they are synchronized with data in the Maximo environment.

The following table lists substitution variables for endpoints and describes the values that replace the variables when the endpoints are executed.

Table 1. Attribute substitution variables for endpoints
Substitution variable Is replaced with . . .
attr:-devicetype- The device type.
attr:-dataItem- The data item is a property name in a JSON message from your device. It supplies values that are displayed in the IoT Device Type Property field on the Map Data Schemas page of the IoT Connector wizard. You can select one of the values when you map a device to a meter.
attr:-lastRunTsUTC- The timestamp for the last cron task run, which is converted to Coordinated Universal Time in ISO8601 format.
attr:-lastRunTsEpoch- The timestamp for the last cron task run, which is converted to Coordinated Universal Time in epoch millisecond format.
attr:-currentTsUTC- The current timestamp, which is converted to Coordinated Universal Time in ISO8601 format.
For the following endpoints, the -currentTsUTC- placeholder is replaced with the current timestamp minus 24 hours and is converted to Coordinated Universal Time in ISO8601 format:
  • Request last message for device type
  • Request last message for a device
To get all readings for a device, the Request last message for a device endpoint is used. The -currentTsUTC- placeholder is replaced with the timestamp for the last cron task run. The timestamp is converted to Coordinated Universal Time format.
attr:-currentTsEpoch- The current timestamp, which is converted to Coordinated Universal Time in epoch millisecond format.
For the following endpoints, the -currentTsEpoch- placeholder is replaced with the current timestamp minus 24 hours and is converted to Coordinated Universal Time in epoch millisecond format:
  • Request last message for device type
  • Request last message for a device
To get all readings for a device, the Request last message for a device endpoint is used. The placeholder is replaced with the timestamp for the last cron task run. The timestamp is converted to Coordinated Universal Time in epoch millisecond format.
attr:-aggType- The property in the JSON message that represents aggregation functions that are applied to the data, for example, minimum, maximum, or average. The values for this property are displayed in the Value field when you map the device types to meters on the Map Data Schemas page of the IoT Connector wizard. You can select one of the values when you map a device to a meter.
attr:-deviceid- The device identifier.

For the Request aggregate result for device type endpoint, the -deviceid- placeholder is replaced with a comma-separated list of the device IDs that are registered in Maximo for the specific device type. The response includes data only for the device IDs in the list.

The maximum number of device IDs that can be included in a single API call is determined by the mxe.int.iot.maxDeviceIdForURL system property.
  • If the number of device IDs that are registered in Maximo for the device type is greater than the value that is specified for the mxe.int.iot.maxDeviceIdForURL property, multiple API calls are run to fulfill the request.
  • If mxe.int.iot.maxDeviceIdForURL is equal to 0, no device IDs are sent in the API call, and the response returns data for all device IDs that are associated with the device type in the platform.
attr:-feedmapprop- This variable is a property name in a JSON message from your device. It supplies values that are displayed in the IoT Device Type Property field on the Map Data Schemas page of the connection wizard. You can select one of the values when you map a device to a meter.