API Catalogue¶
Operations API
The Operations API enables you to read data from data points or issue commands to actuator points.
Structure API
The Structure API enables you to create and manage a structural representation of your buildings in Building X.
Accounts API
The Accounts API enables you, or rather the calling entity, the machine user to discover in which partitions it has access
COMOS Web REST API
A REST API for accessing information from COMOS
Occupancy APIs
Retrieve occupancy data for areas and desks.
Organization APIs
View the list of campuses, buildings, and floors in an organization.
Area APIs
Groups of devices on a floor as defined in Enlighted Manage.
Sensor APIs
Obtain Sensor details including light profile, location, energy consumption, dim level, etc.
Plugload APIs
Obtain Plugload details by floor or area including energy consumption, and status.
Sensor Bluetooth APIs
Obtain the list of BLE sensors and set BLE Mode for sensors.
Conference Room APIs
Control lights in a conference room using scenes.
Tunable White APIs
Set color temperature and light level for Tunable White fixtures.
Data APIs
Get energy savings, temperature, light levels and power for all sensors on a floor.
DALI Emergency APIs
Send emergency lighting commands, get emergency status from sensors, and test emergency drivers.
Demand Response APIs
Contribute to energy load reduction and savings during peak demand time and public holidays.
Industrial Edge Management APIs
Use the IEM API to automate tasks, such as IED onboarding or Industrial Edge Application management.
Industrial Edge Device APIs
Manage the lifecycle of the Industrial Edge Devices.
Industrial Edge Data Processing APIs
Leverage Southbound and Nortbound connectivity of Industrial Edge and distribute data to various systems.
IECTL - Industrial Edge Control
Industrial Edge Control (IECTL) is a Command Line Interface to interact with Industrial Edge and its components.
Analyze MyWorkpiece /Capture4Analysis APIs
List, download and delete recorded datasets. Stream recorded datasets to a MQTT broker.
Analyze MyWorkpiece /Monitor APIs
REST API to manage and download individual or a batch of finalized process monitoring reports. MQTT interface for subscribing to reports of completed monitoring jobs including aggregated result information.
Analyze MyMachine /Condition APIs
Fetch all measurement configuration, group configuration and results generated from machine tools' mechanical fingerprint. Subscribe to measurement results and be notified in machine tool with execution results and details.
Automate MyVisual Inspection /Analyzer APIs
Execute AI models and handle inference results.
Industrial Edge for Machine Tools SDK
To develop your own Industrial Edge for Machine Tools application for this release, please download the latest Industrial Edge for Machine Tools Software Development Kit.
Industrial IoT Typescript SDK
TypeScript/JavaScript Community SDK for Industrial IoT APIs.
Industrial IoT Command Line Interface
Command Line Interface for Industrial IoT APIs.
MindConnect-NodeJs
Starting point for custom field to cloud connectivity implementation in node.js.
MindConnect Node-RED Node
A Node-RED node which can be used to upload the time series data, files and events to the cloud.
Authentication Helper
Chrome extension which simplifies development tasks for which you need to use the SESSION and XSRF-TOKEN to access Industrial IoT APIs.
Identity Management Service
Manages Environments, users and groups within Insights Hub
Resource Access Management
Secure Data Sharing (SDS) enables you to create and manage fine-grained access rights
Message Broker Service
Message Broker is a service that enables asynchronous communication in the Industrial IoT platform.
Oauth Authorization Server
The OAuth Authorization Server provides APIs for authentication and authorization.
Tenant Management Service
A service to manage an environment (tenant), its related subtenants, as well as related data.
Token Management Service
Grant your application access to tenant data.
Usage Transparency Service
Information about ap usage for billing, reporting and quota checking purposes.
IoT File Service
File management for files related to assets.
IoT Time Series Service
Create, read update and delete time series data.
IoT Time Series Subscription
Notification about arrival of new time series data.
IoT Time Series Aggregates Service
Aggregated summaries of numeric time series data.
IoT Time Series Bulk Service
Import large amounts of data into Insights Hub.
Integrated Data Lake Service
Store structured and unstructured data in its native format.
Agent Management Service
API to onboard, offboard, update and delete agents.
Agent Management Async API
API to onboard, offboard, update and delete agents.
MindConnect API
Send data from shop floor devices to the cloud.
MindConnect Async API
Send data from shop floor devices to the cloud via MQTT.
MindConnect MQTT API
Manage certificates for secure connection of the MQTT Agents.
Asset Modeler Async API
Manage Industrial IoT Assets in InsightsHub.
OPC UA Pub Sub Service
Upload Industrial IoT Data according to the OPC UA PubSub Specification.
Commanding API
Execute commands on shopfloor devices.
Asset Management Service
Create digital representation of your shopfloor devices.
Asset Management Subscription Notification
Notifications about changes in the asset model.
Event Management
The Event Management Service is used to capture events generated by devices in Insights Hub.
Event Management Subscription Notification
Notification about changes in event objects.
Notification Service
Send email, SMS or push notifications to consumers.
Work Order Management Service
Basic digital workflow for work requests (maintenance, repair, inspection and incident handling).
Visual Flow Creator Service
Visual data flow programming in Industrial IoT.
Rules Management Service
Define Rules, triggers and actions on your digital assets.
Anomaly Detection Service
Automatically detect unexpected behavior of processes and assets using time series data.
Data Exchange Service
Upload and download data for any purpose.
Event Analytics Service
Essential functionalities for a data-driven analysis of event data.
Job Manager Service
Essential functionalities for a data-driven analysis of event data.
KPI Calculation Service
The KPI Calculation Service computes Key Performance Indicators (KPIs) for an asset.
Model Management Service
Store single file models, algorithms, scripts docker images and training or validation data for ML or AI tasks.
Signal Calculation Service
Aggregate, modify, smoothen and transform the original sensor data.
Signal Validation Service
Analyze data based on custom settings, like thresholds or data window sizes.
Spectrum Analysis Service
Spectrum Signal Analysis allows users to perform time domain and frequency domain analysis.
Trend Prediction Service
Trend Prediction Service predicts future values for time series using linear and nonlinear regression models
Spectrum Analysis Service
Spectrum Signal Analysis allows users to perform time domain and frequency domain analysis.
Data Management Service
The Data Management related APIs handles the entire workflow of data registration and preparation for data contextualization.
Data Query Service
Query contextualized data in Insights Hub.
Semantic Modelling Service
End-to-end capability to import/create, update or delete entire ontological model.
Insights Hub Monitor Plugin SDK
The Insights Hub Monitor Plugin SDK enables web developers to create plugins for Insights Hub Operations Insight.
Industrial IoT SDK V2 for Java
Java clients for Industrial IoT APIs.
Industrial IoT SDK for Node.js
Node.js clients for Industrial IoT APIs.
Industrial IoT SDK for Python
Python clients for Industrial IoT APIs.
MindConnect Library V4
Connectivity Library written in C which allows a client application to exchange data with Siemens Industrial IoT Platform.
User Experience Toolkit for Insights Hub and Industrial IOT
Design language for the overall look and feel of Insights Hub and Industrial IoT.
Mcenter - Openness APIs of Applications
Integrate with Mcenter applications for instrumenting CNC shop floor resource management tasks and accessing shop floor data via REST APIs and MQTT.
OT Companion API
The OT Companion APIs allows you to access the Stations, Assets and Components data.
PlantSight Digital Enablement
APIs and services for project teams and owner-operators to create, visualize, and analyze the digital twin of their asset(s).
PlantSight Immersive Simulation
PlantSight Immersive Simulation enables the use of virtual reality to create a simulated environment and to provide trainings in a safe and controlled environment.
Product Information Hub
The Product Information Hub is offering comprehensive product data and lifecycle information for SIEMENS and other manufacturers through a unified, standardized interface.
Carbon Footprint Indicator for Transportation API
The Carbon Footprint Indicator for Transportation web service generates a standard multi modal routing proposal and calculates transport emissions.
SiGREEN API
The SiGREEN API is a RESTful API that allows you to access the SiGREEN data.
SITRANS SCM IQ API
With the SITRANS SCM IQ API you can get your latest asset condition and automate the processing of event information of your plant's mechanical components.
Teamcenter (X) Product Cost Management REST API
Calculation of product costs and carbon footprint