Reference · built on requestConnectorBuilding management platforms

Siemens Building X

Devices, points, point values, faults, work orders, and energy from Siemens Building X Openness APIs, with commands and ingest.

Request accessPricing ↗

About

Building X is Siemens' cloud building platform. Its Openness APIs follow the JSON:API specification and are grouped by domain: Accounts, Building Structure, Building Geometry, Building Operations, Point Value Ingest, Streaming, Energy, Sustainability, Activities, four Security APIs, Visitor Manager, Fire, and Lifecycle Twin. Data lives in partitions, and requests go to hosts such as eu.buildingx.siemens.com under /api/openness/.

Through Fibric, an operator reads devices and their points in a partition, fetches point values for a time interval, receives point and alarm streams on a registered webhook, and proposes a command to an actuator point or a work order for a team. You approve. The change goes once and the receipt keeps the prior value.

This is a reference listing. It documents what Fibric would read from Siemens Building X and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Devices and their Points in a partition through the Building Operations API, for example GET /partitions/{partitionId}/devices with filter and page parameters
  • PointValues for sensor and set-point Points over a chosen time interval, including aggregated series
  • Faults, Workorders, and Teams as resources of the Building Operations API
  • Real-time point values and device alarm events delivered to registered webhook endpoints through the Streaming API's Point Streams and Alarm Streams
  • Energy consumption, emission, and cost for a location or meter by period through the Energy API
  • Locations, buildings, and the structural tree through the Building Structure API, and partition ids through the Accounts API
  • Devices that connect through another device carry a hasGateway relationship to that gateway

Proposed actions

  • Target capability: propose a command to an actuator Point through the Building Operations API, such as a set-point change or a valve open or close
  • Target capability: propose a Workorder created or updated and assigned to a Team through the Building Operations API
  • Target capability: propose pushing external values into Points through POST /points/{pointId}/values or POST /points/covs on the Point Value Ingest API
  • Target capability: propose a webhook registration and stream subscription for the point ids or device ids to watch, through the Streaming API

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Keep indoor air inside the band

    CO2 and temperature Points stream to a webhook. When a space leaves the band you set, the operator proposes the set-point command on the room's actuator Point and shows the readings that triggered it.

    With Indoor Air

  • Hold demand under the peak

    Energy API consumption by meter and period sets the day's trajectory. The operator proposes staged set-point commands you pre-approved before the peak window, with each step recorded.

    With Peak Demand

  • Turn a fault into a work order

    Faults arrive as resources with their device. The operator drafts a Workorder, picks the Team by area, and proposes it for approval with the fault history attached.

    With Service Interval

Requirements

  • A Building X customer account and the API subscription for each domain you need; the Energy API is an add-on to Building X Energy Manager
  • An API Manager Basic or Advanced role plus Machine User Administrator to create the machine user
  • Machine-user groups matching the access level, such as Operations API read+write for commands and Point Value Ingest API write for ingest
  • The partition id for your buildings, retrievable through the Accounts API
  • A public HTTPS endpoint to receive webhook deliveries when using the Streaming API
Authentication
OAuth 2.0 client_credentials: a machine user's clientId and clientSecret exchanged at https://eu.buildingx.siemens.com/oauth/token with audience https://horizon.siemens.com for a Bearer JWT that lasts about 24 hours.

Limits

  • Each client may make 10 API requests per second; more returns HTTP 429
  • Single-point ingest carries 1 to 100 values per call and multi-point ingest 1 value for up to 50 points per call
  • The Energy API is unavailable to Energy Manager customers on a Navigator conversion subscription
  • The sandbox is read-only, and the Fire, Lifecycle Twin, and physical security APIs are not part of it

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Siemens Building X ↗

Questions and answers

How do I get credentials?
With a customer account, log in to API Manager, open Machine Users, create one with the user groups for the APIs you need, and note the clientId and clientSecret. Without an account, request read-only sandbox credentials through the Siemens developer dashboard; they are granted immediately.
How is pagination done?
With JSON:API page parameters. page[limit] sets the page size, and the links object carries self, first, last, prev, and next. When next is absent there are no more pages. The include parameter returns related resources in one response.
Does Building X push data or must I poll?
Both. The Streaming API lets you register webhook endpoints and subscribe Point Streams for point ids and Alarm Streams for device ids, scoped to a partition. The Building Operations API remains available for on-demand reads of point values by time interval.
Ask about Siemens Building X

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.

This connector listing is developed, published, and supported by Fibric. It describes integration with Siemens Building X through published interfaces. Third-party names and logos identify the systems an integration connects to; they are the property of their respective owners, who are not affiliated with Fibric and do not sponsor or endorse this listing. Trademark policy