Insights Hub Services - Index¶
In this section you will find all currently published services that can be used. This section will be updated regularly as we continuously enrich our ecosystem. Refer to the concepts section for information on the API Versioning and the API Lifecycle in Insights Hub.
Insights Hub APIs are either HTTP-based or messaging-based. HTTP-based APIs come with an OpenAPI specification, describing the HTTP operations offered by a service to be called by clients. Messaging-based APIs come with an AsyncAPI specification, describing the topics and messages offered by a service to either subscribe to or publish to by a client.
The following tables list all available Insights Hub services with a description and the available API versions in the respective regions. By default, API versions are HTTP-based APIs. In case an AsyncAPI is provided the version is annotated accordingly.
Warning
Do not set the ContentType header of GET requests to application/json if the request body is empty. Many firewalls block this as it is identified as invalid request.
Note
Insights Hub will adhere to the API request URL validations in the upcoming release. This is a step to make the environment more secure. The API request URLs will be validated based on the use of trailing slash characters in requests pointing to dedicated resources. Please refer to the list below which contains examples of incorrect URLs and correct URLs. This will be applicable to all APIs in Insights Hub.
| Examples of malformed requests | Examples of well-formed requests |
|---|---|
GET https://gateway.{region}.{mindsphere-domain}/api/iottsaggregates/v3/aggregates/{assetId}/{aspectName}/ | GET https://gateway.{region}.{mindsphere-domain}/api/iottsaggregates/v3/aggregates/{assetId}/{aspectName} |
GET https://{tenantName}-assetmanagement.{region}.{mindsphere-domain}/api/assetmanagement/v3/assets/{id}/?includeShared=true | GET https://{tenantName}-assetmanagement.{region}.{mindsphere-domain}/api/assetmanagement/v3/assets/{id}?includeShared=true |
PUT https://{tenantName}-assetmanagement.{region}.{mindsphere-domain}/api/assetmanagement/v3/assettypes/{id}/ | PUT https://{tenantName}-assetmanagement.{region}.{mindsphere-domain}/api/assetmanagement/v3/assettypes/{id} |
Platform Core¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| Identity Management | Use Customer Management APIs to manage your customers (e.g. add new ones or change existing) for own tenants only. | 3.3.2 | 3.3.1 |
| Resource Access Management | Use Resource Access Management APIs to manage your policies (e.g. add new ones or change existing) for own tenants only. | 3.2.0 | 3.3.0 |
| Message Broker | Use Message Broker APIs to enable asynchronous communication in the platform. | 3.0.2 | 3.0.2 |
| OAuth Authorization Server | Use OAuth Authorization Server to request authentication and authorization. | 3.1.0 | 3.1.0 |
| Tenant Management | Use Tenant Management to manage: subtenants, tenant information and legal information. | 4.7.0 | 4.7.0 |
| Token Management | The Token Manager API is used to provide an application access to data of other tenants, who use the application. | 3.5.0 | 3.5.0 |
| Usage Transparency Service | Usage Transparency Service offers a UI giving insight on your resource consumption on the Insights Hub environment. For Developers it as offers an API to track a metric defined by the developers. This metric can also be retrieved via an API of UTS. | 3.2.0 | 3.2.0 |
IoT and Storage¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| IoT File | File Service to read, write and delete files: upload, update and delete files associated to assets; store metadata information, and search for files by metadata. | 4.0.0 3.6.0 | 3.2.4 |
| IoT Time Series | Use Time Series to create, read, update and delete dynamic data. Since time series data are always related to an asset, the instance of an asset must have been created by you beforehand. | 3.7.1 | 3.5.0 |
| IoT Time Series Subscription Notification | Get the notification for latest arrival of timeseries data. | 3.1.0 | - |
| IoT TS Aggregates | Use Time Series Aggregates Service to read aggregated time series values. Retrieve the following aggregated values per interval: Count, Sum, Average, Minimum, Maximum, First Value, Last Value,Standard Deviation. | 3.6.0 4.3.0 | 3.4.0 4.1.0 |
| IoT TS Bulk | Use Time Series Bulk Service to import and read high frequency time series data. | 3.8.1 | 3.7.0 |
| IoT TS Stream Registration | Use Time Series Streaming Service to stream timeseries data to external streaming component. | - | 3.0.0 |
| Integrated Data Lake | Integrated Data Lake is an application in Insights Hub to import and store the historical IoT data, access cross accounts and perform analytics on the data. | 3.11.0 | 4.0.1 3.4.2 |
Connectivity¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| Agent Management | Use Agent Management to create, edit or remove MindConnect elements, on-board and off board agents and set relations to assets. | 3.5.2 | 3.4.0 |
| Agent Management Async API | Use Agent Management to acquire an agent access token via MQTT agents. | 3.0.0 | 3.0.0 |
| MindConnect API | Use MindConnect API to develop custom agents and connect your device or application to Insights Hub. | 3.6.0 | 3.6.0 |
| MindConnect Async API | Use MindConnect Async API to ingest timeseries data. | 3.1.0 | 3.0.0 |
| MindConnect MQTT API | Use MindConnect MQTT API to manage the certificates for securely connecting the MQTT agents with Insights Hub. | 3.0.1 | 3.0.0 |
| Asset Modeler Async API | Asset Modeler Async API to to create assets, types, and mappings. | 3.1.0 | 3.0.0 |
| OPC UA PubSub | Use MindConnect OPC UA PubSub to provide an MQTT-based API to device agents for uploading data according to the OPC UA PubSub Specification. | 4.0.0 (Async API) 3.0.2 (Async API) | - |
| Commanding Feature | Use Commanding Feature to send command and/or data associated with the command up to 20 MindConnect MQTT agents. | 3.1.1 (Async API) 3.2.2 | 3.1.1 (Async API) 3.2.2 |
| Remote Services API | Use Remote Services API to facilitate secure connectivity to devices on the shopfloor, by means of Fine Grained Authorization Control (FGAC) | 3.0.0 | - |
Advanced Services¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| Asset Management | Represent physical assets from your site in Insights Hub. Use models and create instances, set relations to others and create structures such as hierarchies. | 3.18.4 | 3.16.3 |
| Asset Management Subscription Notification | Get the notification for changes to Asset Model | 3.1.0 | - |
| Event Management | Manage standardized and customized events. Acquire events from the field & other applications. | 3.16.3 | 3.16.3 |
| Event Management Subscription Notification | Get the notification for latest creation or updation of Event. | 3.1.0 | - |
| Notification Service | Use APIs or graphical user interface to send information to your users & customers via e-mail, sms or push/scheduled notification. | 4.4.2 3.4.1 | 4.2.0 3.4.0 |
| Case Management Service | Provide a basic digital workflow for work requests (maintenance, repair, inspection and incident handling) that are essential to monitor asset health and to detect technical issues before they lead to asset failure and downtime. | 3.3.0 | 3.3.0 |
| Visual Flow Creator | Visual Flow Creator API service can be used to create, update, retrieve, delete and other functionalities for the data flows | 3.0.0 | - |
| Rules Management | Rules Management API service can be used for configuring, reading, deleting and updating rules. | 4.0.0 | - |
Analytics Services¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| Data Exchange | The Data Exchange Service provides remote file storage and management support through simple REST API calls. The service offers support for uploading, downloading, renaming, and publishing within the same tenant files or folders. | 3.0.1 | 3.0.1 |
| Job Manager | The Job Manager Service allows customers to execute Zeppelin Notebooks using a scheduling mechanism, also providing full support for the execution environment, cleanup, storage and library support required to run the models. | 3.2.0 | 3.0.0 |
| Model Management | The Model Management Service provides analytical model management file storage with versioning support. The service provides help in maintaining version, dependency, parameters and authorship information. | 3.2.0 | 3.1.0 |
Data Contextualization Services¶
| Service | Description | Europe 1 | Private Cloud |
|---|---|---|---|
| Data Management | The Data Management Service is used to prepare data for establishing semantic correlations and data query processing | 4.10.0 | 4.6.0-Pvt-1.0 |
| Data Query | The Data Query Service is used to create, update, retrieve and delete queries | 4.10.0 | 4.6.0-Pvt-1.0 |
| Semantic Modelling | The Semantic Modelling Service provides end-to-end capability to import/create, update or delete entire ontological/Semantic model | 4.10.0 | 4.6.0-Pvt-1.0 |