API Catalogue¶

The Operations API enables you to read data from data points or issue commands to actuator points.

The Structure API enables you to create and manage a structural representation of your buildings in Building X.

The Accounts API enables you, or rather the calling entity, the machine user to discover in which partitions it has access

A REST API for accessing information from COMOS

Retrieve occupancy data for areas and desks.

View the list of campuses, buildings, and floors in an organization.

Groups of devices on a floor as defined in Enlighted Manage.

Obtain Sensor details including light profile, location, energy consumption, dim level, etc.

Obtain Plugload details by floor or area including energy consumption, and status.

Obtain the list of BLE sensors and set BLE Mode for sensors.

Control lights in a conference room using scenes.

Set color temperature and light level for Tunable White fixtures.

Get energy savings, temperature, light levels and power for all sensors on a floor.

Send emergency lighting commands, get emergency status from sensors, and test emergency drivers.

Contribute to energy load reduction and savings during peak demand time and public holidays.

Use the IEM API to automate tasks, such as IED onboarding or Industrial Edge Application management.

Manage the lifecycle of the Industrial Edge Devices.

Leverage Southbound and Nortbound connectivity of Industrial Edge and distribute data to various systems.

Industrial Edge Control (IECTL) is a Command Line Interface to interact with Industrial Edge and its components.

List, download and delete recorded datasets. Stream recorded datasets to a MQTT broker.

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.

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.

Execute AI models and handle inference results.

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.

TypeScript/JavaScript Community SDK for Industrial IoT APIs.

Command Line Interface for Industrial IoT APIs.

Starting point for custom field to cloud connectivity implementation in node.js.

A Node-RED node which can be used to upload the time series data, files and events to the cloud.

Chrome extension which simplifies development tasks for which you need to use the SESSION and XSRF-TOKEN to access Industrial IoT APIs.

Manages Environments, users and groups within Insights Hub

Secure Data Sharing (SDS) enables you to create and manage fine-grained access rights

Message Broker is a service that enables asynchronous communication in the Industrial IoT platform.

The OAuth Authorization Server provides APIs for authentication and authorization.

A service to manage an environment (tenant), its related subtenants, as well as related data.

Grant your application access to tenant data.

Information about ap usage for billing, reporting and quota checking purposes.

File management for files related to assets.

Create, read update and delete time series data.

Notification about arrival of new time series data.

Aggregated summaries of numeric time series data.

Import large amounts of data into Insights Hub.

Store structured and unstructured data in its native format.

API to onboard, offboard, update and delete agents.

API to onboard, offboard, update and delete agents.

Send data from shop floor devices to the cloud.

Send data from shop floor devices to the cloud via MQTT.

Manage certificates for secure connection of the MQTT Agents.

Manage Industrial IoT Assets in InsightsHub.

Upload Industrial IoT Data according to the OPC UA PubSub Specification.

Execute commands on shopfloor devices.

Create digital representation of your shopfloor devices.

Notifications about changes in the asset model.

The Event Management Service is used to capture events generated by devices in Insights Hub.

Notification about changes in event objects.

Send email, SMS or push notifications to consumers.

Basic digital workflow for work requests (maintenance, repair, inspection and incident handling).

Visual data flow programming in Industrial IoT.

Define Rules, triggers and actions on your digital assets.

Automatically detect unexpected behavior of processes and assets using time series data.

Upload and download data for any purpose.

Essential functionalities for a data-driven analysis of event data.

Essential functionalities for a data-driven analysis of event data.

The KPI Calculation Service computes Key Performance Indicators (KPIs) for an asset.

Store single file models, algorithms, scripts docker images and training or validation data for ML or AI tasks.

Aggregate, modify, smoothen and transform the original sensor data.

Analyze data based on custom settings, like thresholds or data window sizes.

Spectrum Signal Analysis allows users to perform time domain and frequency domain analysis.

Trend Prediction Service predicts future values for time series using linear and nonlinear regression models

Spectrum Signal Analysis allows users to perform time domain and frequency domain analysis.

The Data Management related APIs handles the entire workflow of data registration and preparation for data contextualization.

Query contextualized data in Insights Hub.

End-to-end capability to import/create, update or delete entire ontological model.

The Insights Hub Monitor Plugin SDK enables web developers to create plugins for Insights Hub Operations Insight.

Java clients for Industrial IoT APIs.

Node.js clients for Industrial IoT APIs.

Python clients for Industrial IoT APIs.

Connectivity Library written in C which allows a client application to exchange data with Siemens Industrial IoT Platform.

Design language for the overall look and feel of Insights Hub and Industrial IoT.

Integrate with Mcenter applications for instrumenting CNC shop floor resource management tasks and accessing shop floor data via REST APIs and MQTT.

The OT Companion APIs allows you to access the Stations, Assets and Components data.

APIs and services for project teams and owner-operators to create, visualize, and analyze the digital twin of their asset(s).

PlantSight Immersive Simulation enables the use of virtual reality to create a simulated environment and to provide trainings in a safe and controlled environment.

The Product Information Hub is offering comprehensive product data and lifecycle information for SIEMENS and other manufacturers through a unified, standardized interface.

The Carbon Footprint Indicator for Transportation web service generates a standard multi modal routing proposal and calculates transport emissions.

The SiGREEN API is a RESTful API that allows you to access the SiGREEN data.

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.

Calculation of product costs and carbon footprint