MindSphere 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 MindSphere.
MindSphere 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 MindSphere 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
MindSphere 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 MindSphere.
| 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 | Europe 2 | China 1 |
|---|---|---|---|---|
| Identity Management | Use Customer Management APIs to manage your customers (e.g. add new ones or change existing) for own tenants only. | 3.3.0 | 3.1.2 | 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 | 3.1.0 |
| Tenant Management | Use Tenant Management to manage: subtenants, tenant information and legal information. | 4.7.0 | 4.7.0 | 4.6.1 |
| Token Management | The Token Manager API is used to provide an application access to data of other tenants, who use the application. | 3.3.0 | 3.3.0 | 3.3.0 |
| Usage Transparency Service | Usage Transparency Service offers a UI giving insight on your resource consumption on the MindSphere 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 | 3.2.0 |
IoT and Storage¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| 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. | 3.2.4 | 3.2.4 | 3.2.1 |
| 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.6.0 | 3.6.0 | 3.4.1 |
| 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.5.0 4.2.0 | 3.5.0 4.2.0 | 3.4.0 |
| IoT TS Bulk | Use Time Series Bulk Service to import and read high frequency time series data. | 3.7.0 | 3.7.0 | 3.4.0 |
| Integrated Data Lake | Integrated Data Lake is an application in MindSphere to import and store the historical IoT data, access cross accounts and perform analytics on the data. | 3.4.2 | 3.4.2 | - |
Connectivity¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| Agent Management | Use Agent Management to create, edit or remove MindConnect elements, on-board and off board agents and set relations to assets. | 3.4.0 | 3.3.0 | 3.3.0 |
| MindConnect API | Use MindConnect API to develop custom agents and connect your device or application to MindSphere. | 3.5.0 | 3.5.0 | 3.5.0 |
| MindConnect 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. | 3.0.1 (Aysnc API) | - | - |
Advanced Services¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| Asset Management | Represent physical assets from your site in MindSphere. Use models and create instances, set relations to others and create structures such as hierarchies. | 3.16.4 | 3.16.4 | 3.16.3 |
| Event Management | Manage standardized and customized events. Acquire events from the field & other applications. | 3.14.0 | 3.13.0 | 3.13.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.2.0 3.4.0 | 4.2.0 3.4.0 | 3.4.0-cn1-0.0 |
Analytics Services¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| Anomaly Detection | The Anomaly Detection Service aims to automatically detect unexpected behaviour of processes and assets using time series data. | 3.4.0 | 3.4.0-eu2-0.0 | 3.3.0 |
| 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.0 | 3.0.0 | 3.0.0 |
| Event Analytics | The Event Analytics Service provides the essential functionality for a data-driven analysis of event data. It enables the user to get a better grasp of what is happening inside the system through statistical analysis. | 3.1.1 | 3.1.1 | 3.1.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.0.0 | 3.0.0 | 3.0.0 |
| KPI Calculation | The KPI Calculation Service computes Key Performance Indicators (KPIs) for an asset. It uses data source such as sensors, control events and calendar entries. | 3.1.0 | 3.1.0 | 3.1.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.1.0 | 3.1.0 | 3.1.0 |
| Signal Calculation | The Signal Calculation Service processes sensor time series data of an entity. The service aggregates, modifies, smoothes and transforms the original sensor data for further analysis or storage along with the original data. | 3.1.0 | 3.1.0 | 3.1.0 |
| Signal Validation | The Signal Validation Service validates sensor time series data of an entity. The API offers a set of common operations for signal validation. | 3.1.0 | 3.1.0 | 3.1.0 |
| Spectrum Analysis | The Spectrum Analysis Service allows users to perform time domain and frequency domain analysis. | 3.0.0 | 3.0.0 | 3.0.0 |
| Trend Prediction | The Trend Prediction Service predicts future values for time series using linear and non-linear regression models. It is a forecasting framework, that has many useful applications in the area of Process & Condition Monitoring. | 3.1.0 | 3.1.0 | 3.1.0 |
MindConnect Open Edge Services¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| Deployment Workflow | The Deployment Workflow Service is used to define handshaking processes with devices. | 3.0.0 | 3.0.0 | 3.0.0 |
| Device Configuration | The Device Configuration Service provides interfaces for managing configuration files for devices and for sending configuration jobs to devices. | 3.0.1 | 3.0.1 | 3.0.1 |
| Device Management | The Device Management Service is used for managing device types and a database of all devices as well as for mapping device agents to devices. | 3.0.0 | 3.0.0 | 3.0.0 |
| Device Status | The Device Status Service provides interfaces for managing databases of all installed software and health information of devices. | 3.0.0 | 3.0.0 | 3.0.0 |
| Edge App Deployment | The Edge App Deployment Service provides an interface for deploying apps to devices. | 3.0.0 | 3.0.0 | 3.0.0 |
| Edge App Instance Management | The App Instsance Management Service is used for keeping a record of Edge app instances running on devices and their configurations. | 3.0.0 | 3.0.0 | 3.0.0 |
| Firmware Deployment | The Firmware Deployment Service provides an interface for deploying firmware to devices. | 3.0.0 | 3.0.0 | 3.0.0 |
Semantic Data Interconnect Services¶
| Service | Description | Europe 1 | Europe 2 | China 1 |
|---|---|---|---|---|
| SDI Data Management | The SDI Data Management Service is used to prepare data for establishing semantic correlations and data query processing | 4.5.0 | - | |
| SDI Data Query | The SDI Data Query Service is used to create, update, retrieve and delete queries | 4.5.0 | - | |
| SDI Semantic Modelling | The SDI Semantic Modelling Service provides end-to-end capability to import/create, update or delete entire ontological/Semantic model | 4.5.0 | - |
Any questions left?
Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.