A6V12837267 Building Automation Apis
“
Specifications
- Product Name: Building X
- Manufacturer: Siemens
- APIs Included: Accounts API, Structure API, Point Value Ingest
API, Geometry API - Developer Portal:
developer.siemens.com/building-x-openness/index.html - API Manager Application: Included
- Mendix Connector: Available as an add-on
Product Usage Instructions
Accounts API
The Accounts API provides read access to company, user groups,
and partitions for the current machine user.
Structure API
The Structure API offers read access to locations, devices, and
data points per data point group. It also allows users to explore
linked equipment to the building topology and perform actions like
creating, updating, and deleting equipment.
Point Value Ingest API
The Point Value Ingest API enables users to ingest from 1 to 100
values into the data points associated with virtual devices for
integration into the Building X platform.
Developer Portal
The Xcelerator Developer Portal provides an overview of all
available APIs, tutorials, and the related OpenAPI v3
specification. Customers with the required subscriptions can use
the APIs.
API Manager Application
The API Manager app allows users to manage machine user
credentials, obtain an overview of API usage, and try out the
APIs.
FAQ
What is the purpose of the Power BI template with Operations
and Energy Dataset?
The Operations dataset serves as the foundation for designing
the Energy and Building Performance Dashboard within Power BI. It
provides a holistic view of building portfolios, including
information related to locations, equipment, devices, points, and
point values. Detailed descriptions of tables and columns are
available in the Developer Portal.
How can I manage Connected Devices with the Subscription
plan?
The Subscription plan allows users to manage Connected Devices
compatible with the Cloud Service. Data can be onboarded from
various sources like Connected Devices, 3rd party cloud systems,
and files.
What does the Building Point Value Ingest APIs subscription
include?
The subscription includes the ability to write point values via
the Point Value Ingest API with a limit of 1,000,000 API calls per
year. The billing is done annually with auto-renewal.
“`
Data Sheet
Building Automation APIs
Building X
Openness allows customer access to smart building and equipment data through application programming interfaces (APIs and connectors), enabling application development and data integration. Building Automation APIs provide developers with access to building, equipment, device and energy data. These APIs are fine-tuned for self-service integration, allowing developers to seamlessly automate processes and extend their applications using Building X resources, or conversely, enrich Building X with data from their services
Accounts API Structure API Point Value Ingest API Geometry API Developer portal API Manager application Mendix connector Microsoft Power BI operations dataset template buildingx.siemens.com
A6V12837267_en-2025-06-25
Smart Infrastructure
Functions
Accounts API Read access to company, user groups and partitions for the current machine user.
Structure API Read access to locations, devices, and data points per data point group. Read access to campus and building topologies, like buildings, floors, rooms. Explore linked equipment to the building topology. Create, update and delete equipment.
2 Siemens Siemens
Point Value Ingest API Ingest from 1 to 100 values into the data points associated with virtual devices for
integration into Building.
Geometry API The Geometry API allows you to interact with the 2D geometry of building floor plans. This API is structured around the Floor plan and Geometry resources, providing a comprehensive framework for working with spatial data. A floor plan serves as the container for geometry, which is represented in the GeoJSON format, providing clarity and ease of use in managing building layouts and spatial information. Get floor plans Get floor plan geometry Get floor plan geometry palettes Get floor plan geometry symbols
Developer Portal The Xcelerator Developer Portal provides an overview over all available APIs, tutorials and the related OpenAPI v3 specification. Customers with the required subscriptions can use the APIs. Link: developer.siemens.com/building-x-openness/index.html
API Manager Application The API Manager app provides (i) the ability to manage machine user credentials for enabling access to the user licensed APIs, (ii) an overview about API usage and (iii) the ability to try out the API.
Power BI template with Operations and Energy Dataset The Operations dataset serves as the foundation for the design of the Energy and Building Performance Dashboard within Power BI, leveraging the capabilities of both Power BI and the Building X platform. Its primary goal is to provide a holistic view of multiple facets associated with building portfolios, including information related to locations, equipment,
A6V12837267_en-2025-06-25
devices, points, and point values. A detailed description of the tables and columns provided can be found in the Developer Portal. Link: developer.siemens.com/building-x-openness/ resources/power-bi-templates/power-bi-operations-dataset-overview.html
Mendix Connector
The Building X Connector for Mendix streamlines the creation of new business value using LowCode powered by Mendix and the Building X platform. This Siemens supported connector at no cost , provides a domain model encompassing all core entities exposed by Building X. It also offers actions for retrieving, creating, updating, and deleting these entities, which become available in the Mendix toolbox upon installing the Connector. The connector structure enables Mendix developers to build innovative applications. Link: marketplace.mendix.com/link/component/240566
Siemens Siemens
The following Building X APIs are supported and can be used with the subscription listed below: Building Structure API (Read and Write) Building Geometry API (Read) Point Value Ingest API (Write) The connector also supports the following APIs, but to use them effectively, separate add-on licenses from the related product line are required to use these APIs: Building Energy API (Read) – Requires Energy Add-on License Security Identities and Privileges API (Read) Activities API(Read) – Requires Security
add-on Licenses Building Operations API (Read and Write) – Requires Operation Manager Add-on
License
Enabling Building X Functions Self-Administration Allows User as well as device management by the Customer. Accounts Application Ability to manage users with a role-based access control. New users can be invited to access the Cloud Service and given appropriate access rights via user groups. Users can log in with two-factor authentication and manage their user account themselves. Data can be logically grouped into partitions and given access via user groups. Data Hosting and Data Usage Hosts and processes personal and non-personal data in data centers located in Europe. For information regarding processing of personal data and locations Customer may refer to the Data Privacy Terms. Devices Application
3 A6V12837267_en–
2025-06-25
Subscription
Ability to manage Connected Devices compatible with the Cloud Service.
Data Setup Application Ability to onboard data by adding meaning and structure to it. The data can be onboarded from multiple sources, such as Connected Devices, 3rd party cloud systems and files.
Ask Building X Ability to ask questions in different languages about Building X technical information, utilizing GenAI.
The subscription plan depends on the agreement between Customer and Siemens. 1) Standard Subscription Plan if the customer purchases the subscription via the Siemens online store
Includes Functions Subscription metric Subscription term Billing term Upscale Downscale/Cancellation Connected Devices Permitted Users
Building Point Value Ingest APIs Point Value Ingest API Write
per 1,000,000 API calls per year Annually, auto-renewal
Annually, payment in advance Effective immediately, pro-rated billing Effective with end of subscription term
To be purchased separately Unlimited, Extended Use
Includes Functions Subscription metric
Subscription term Billing term Upscale Downscale/Cancellation Connected Devices Permitted Users
Building Structural and Geometrical Information APIs
Geometry API
Structure API
Read
Read, Write
per 500,000 API calls per per 500,000 API calls per
year
year
Annually, auto-renewal
Annually, payment in advance
Effective immediately, pro-rated billing
Effective with end of subscription term
To be purchased separately
Unlimited, Extended Use
The Standard subscription plan is the regular, scalable Offering for this Cloud Service. The subscription term is twelve (12) months with automatic renewal; the Cloud Service fee is paid in advance. The subscription plan can be upscaled at any time and Cloud Service fees for upscales are calculated on a pro-rated basis. The Customer can also scale down the Cloud Service effective with the end of the current subscription term. The subscription fee will be adjusted for the upcoming billing term. The Cloud Service can be cancelled any time, effective with the end of the current subscription term.
An API call is a dedicated access to a resource endpoint of the API resulting in a server request.
Customer may purchase required Connected Devices separately.
Extended Use entitles Customer to authorize its Affiliates and third parties to access and use the Cloud Services in accordance with the rights set out in the Terms and Conditions.
Power BI Operations and Energy Dataset template
The Operations API subscription and/or Energy API subscription come with the Power BI Operations and Energy Dataset template. You can download the Power BI template from API Manager after you have activated your API subscription. You need an active Operations
4 Siemens Siemens
A6V12837267_en-2025-06-25
API or Energy API subscription to fill the Operations related tables. You also need an active Energy API subscription to fill the Energy related tables. Further information, including limitations of this offering, can be found on the Developer Portal.
2) Custom Subscription Plan Any subscriptions that are not purchased via a Siemens online store are Custom Subscription Plans. Under a Custom Subscription Plan the details regarding functions, subscription metric, term, billing, up- and downscaling, Connected Devices as well as Permitted Users are set out in the agreement between the Customer and Siemens.
Prerequisites
Supported Connected Devices
This table only applies for packages with Structure API.
The Cloud Service is currently compatible with commercially available Connected Devices. Connected Devices enable the Cloud Service to exchange data with the technical building infrastructure. A description of the available Connected Devices is provided below.
SIEMENS: Connect X200 SIEMENS: Connect X300 SIEMENS: Connect Software SIEMENS: Intelligent Valve SIEMENS: Desigo CC
SIEMENS: Desigo PXC 4/5/7 SIEMENS: Desigo Optic F200
List of Supported Connected Devices
The Connect X200 edge gateway is powered with DC 24V or AC 24V and may require an enclosure.
The Connect X200 includes embedded software (for example, firmware and factory installed applications collectively referenced herein as Software) to supply building data to this Cloud Service.
The Connect X300 edge gateway is powered with DC 24V and may require an enclosure.
The Connect X300 includes embedded software (for example, firmware and factory installed applications collectively referenced herein as Software) to supply building data to this Cloud Service.
Connect Software edge gateway is running on Windows 10 or Windows 11 Hyper-V and requires computer hardware.
Connect Software includes multiple software applications collectively referenced herein as Software to supply building equipment data to this Cloud Service.
Intelligent Valve is powered with AC 24V.
Intelligent Valve includes embedded firmware V1.19.7671 or higher to supply valve data to this Cloud Service.
Desigo CC software product is running on Windows computer hardware. The supported software version is Desigo CC V6 or higher.
Desigo CC includes multiple software extensions collectively referenced herein as Software to supply building data to this Cloud Service.
Desigo PXC4/5/7 hardware is powered with AC 24V. The supported hardware devices for this Cloud Service are PXC4-2.E16S, PXC4-2.E16, PXC5.E24, PXC7.E400S/M/L and PXC5.E003 with firmware version v02.21.194.xx or higher.
Desigo Optic hosted on CFG3.F200 hardware is powered with AC 24V. The supported software version is V5.1.5 or higher to connect to this Cloud Service.
To use the Cloud Service, a Connected Device must be installed on site, fully operational and connected to the Internet. The Customer is responsible for the provision of the Connected Device on site and all associated costs for the provision of the Cloud Service in accordance with the associated documentation for the Connected Device.
Siemens Siemens
5 A6V12837267_en–
2025-06-25
Building X Connector for NiagaraTM
A Niagara supervisor and JACE® with Niagara Framework® 4.14 is supported for this Cloud Service.
The Building X Connector for NiagaraTM must be deployed on the Niagara Framework® to supply building data to this Cloud Service.
The Tridium EULA is applicable, see https://www.tridium.com/us/en/ eula.
Niagara FIPS mode and web proxy configuration are not supported.
Microsoft Power BI To use the Power BI Operations Dataset template, you need either Power BI Desktop for dashboard creation and customization or Power BI Services for online collaboration and analysis. These tools are essential for working with the provided template. Contact your Microsoft agent for the necessary licenses. Building X Connector for Mendix To use the Building X Connector for Mendix Customer must register for a Mendix account and download Mendix Studio Pro app. Additionally, an existing Mendix app is required.
Web browser and Viewing Devices Chrome is recommended to use the Cloud Service, but other standard browsers might also serve this function. Screen resolution of 1920×1080 pixels or higher is recommended for best user experience.
Internet Connection The bandwidth of Customer’s internet connection determines the performance of the Cloud Service.
Ordering
To order a subscription plan and connected devices, Customer must request a quote from its Siemens sales representative.
Product Documentation
1) Product Documentation under a Standard Subscription Plan
General Contractual Documents Building X – Building Automation APIs Data Sheet Supplemental Terms for Buildings
General Software Terms and Cloud Supplemental Terms Base Terms International Siemens Acceptable Use Policy Minimum Terms
Links www.siemens.com/buildingx/data-sheet/ building-automation-apis www.siemens.com/buildingx/data-sheet/ supplemental-terms https://www.siemens.com/si/cloud/terms
https://www.siemens.com/si/cloud/terms https://www.siemens.com/si/cloud/terms www.siemens.com/buildingx/data-sheet/ minimum-terms
2) Product Documentation under a Custom Subscription Plan
The contractual documents and the Product Documentation are set out in Siemens’ offer to the Customer.
3) Data Privacy Terms
Data Privacy Terms Data Privacy Terms Data Privacy Terms Annexes Building X
Links https://www.siemens.com/dpt/si https://www.siemens.com/dpt/si
6 Siemens Siemens
A6V12837267_en-2025-06-25
Topology
4) Technical Documents
Technical Documentation Building X – Online help
Link www.siemens.com/buildingx/sid
Data communication between the Connected Devices on-premises and the Cloud Service requires internet connectivity (to be provided by the Customer).
Specific Terms
High-Risk Use
Customer acknowledges and agrees that:
a) the Offerings are not designed to be used for the operation of or within a High-Risk System if the functioning of the High-Risk System is dependent on the proper functioning of the Offerings; and
b) the outcome from any processing of data through the use of the Offerings is beyond Siemens’ control.
Service Level Agreement
Siemens shall use commercially reasonable efforts to make the Cloud Services available for a monthly uptime percentage of ninety-eight percent (98%).
Except for:
a) Planned downtime, agreed downtime, routine and emergency maintenance, b) Cyberattacks, c) the public, third party and/or customer’s internet and communications networks, d) data, software, hardware, telecommunications, infrastructure, power, build-packs or networking equipment not provided by Siemens, e) Customers and Users negligence or failure in using the Cloud Service and/or in not following the instructions of published documentation, f) system configurations and platforms not supported by Siemens, g) system administrations, action, commands and file transfers of Customer or User, h) modifications or alterations not made by Siemens, i) unauthorized access via Customer’s credentials and/or j) any other failure outside of Siemens reasonable control.
Customer Support
Siemens offers helpdesk support. Customer may contact its local Siemens representative for support requests.
Siemens Siemens
7 A6V12837267_en–
2025-06-25
Issued by Siemens Switzerland Ltd Smart Infrastructure Global Headquarters Theilerstrasse 1a CH-6300 Zug +41 58 724 2424 www.siemens.com/buildingtechnologies
Document ID Edition
A6V12837267_en-2025-06-25
© Siemens 2025 Technical specifications and availability subject to change without notice.
Documents / Resources
 |
SIEMENS A6V12837267 Building Automation Apis [pdf] User Guide A6V12837267 Building Automation Apis, A6V12837267, Building Automation Apis, Automation Apis, Apis |