Skip to content

Custom Data Services API

Idea

The Custom Data Services API enables users to register and manage custom topic mappings for data integration within Insights Hub. This API provides a comprehensive set of endpoints for creating, retrieving, updating and deleting custom topic registrations and their associated mappings.

Access

For accessing this service, you need to have the respective roles listed in MindConnect API roles and scopes.

Basics

Custom Topic Registrations

The core functionality of this API is to manage custom topic registrations for data integration within Insights Hub. You can create, retrieve, update, and delete custom topic mappings and their associated configurations.

Mapping Information

The mapping information represents the details of a custom data mapping, which includes:

  • Asset ID
  • Aspect Name
  • Variable Name
  • Value Expression
  • Timestamp Expression
  • Time Converter settings

Time Converter Options

This API supports multiple time format conversions, such as Epoch, Unix Timestamp, RFC2822, RFC822, RFC3339, MySQL Timestamp, Human Readable Format, and JavaScript Date Format. You can specify the appropriate time converter for their data requirements.

Optimistic Locking

The API uses the ETag mechanism for optimistic locking to prevent concurrent modifications.

Limitations

In order to give optimal performance, Custom Data Services API provides technical limits on API usage and resources which needs to be incorporated while using it.

The following are the technical limits for resource usage:

Resource Public Cloud Local Private Cloud (LPC)
Max topics allowed per agent 5 10
Max topics allowed per tenant 50 3000
Max topic hierarchy allowed 7 15

Note

If the converter option is set as ISO8601 and the timestamp ingested has a precision of more than 3 digits (in millisecond unit) for example, 2025-03-28T07:00:14.123456789Z, the timestamp forwarded to the Insights Hub Monitor is 2025-03-28T07:00:14:123Z. This is because the time series handles timestamps only with upto 3 millisecond of precision.

Features

The Custom Data Service exposes its API for realizing the following tasks:

  • Create new topic mappings
  • Retrieve, update and delete the existing custom data mappings
  • Manage mapping rules and expressions
  • Support for multiple time format conversions

Example Scenario

A manufacturing company wants to integrate its own sensor data into the Insights Hub platform to leverage the advanced analytics and monitoring capabilities. By leveraging the Custom Data Services API, this manufacturing company can seamlessly integrate its proprietary data sources with the Insights Hub.

Last update: May 14, 2025

Except where otherwise noted, content on this site is licensed under the Development License Agreement.