Skip to content
Siemens Xcelerator Marketplace
Siemens
Siemens
Siemens
Siemens
Siemens Xcelerator Developer Portal
Profile
Community Settings
Marketplace Lists
Contact Support
Log out
DepotFinity
Home
Documentation
APIs
Resources
Guidelines
Community
Initializing search
Home
Documentation
APIs
Resources
Resources
Mendix
Mendix
Opensource
Opensource
Playgrounds
Playgrounds
Sdks
Sdks
Guidelines
Guidelines
Community
Tags
How-Tos and Tutorials
How-Tos and Tutorials
Overview
Siemens Xcelerator
Siemens Xcelerator
Frequently Asked Questions
Siemens Workspace on Postman Network
Siemens Workspace on Postman Network
Siemens API Catalogue
Testing APIs (with credentials)
Testing APIs (without credentials)
Design Systems and Components
Design Systems and Components
Design Systems
Technology Governance for Marketplace Sellers
Technology Governance for Marketplace Sellers
Cybersecurity Baseline for Seller Offerings
Cybersecurity Baseline for Seller Offerings
Cybersecurity Baseline for Seller Offerings
Building X Openness
Building X Openness
Overview
APIs & Services
APIs & Services
Developer's Guide
Developer's Guide
Getting Started
Create a Token
Using the API reference
Accounts API
Accounts API
Overview
Quick Start
API Reference
Changelog
Building Structure API
Building Structure API
Overview
Quick Start
API Reference
Changelog
Building Geometry API
Building Geometry API
Overview
Quick Start
API Reference
Changelog
Building Operations API
Building Operations API
Overview
Quick Start
API Reference
Changelog
Point Value Ingest API
Point Value Ingest API
Overview
Quick Start
API Reference
Changelog
Energy API
Energy API
Overview
Quick Start
API Reference
Changelog
Security Identities and Privileges API
Security Identities and Privileges API
Overview
Quick Start
API Reference
Changelog
Security Activities API
Security Activities API
Overview
Quick Start
API Reference
Changelog
Fire API
Fire API
Overview
Quick Start
API Reference
Changelog
Lifecycle Twin API
Lifecycle Twin API
Overview
Quick Start
API Reference
Changelog
Developer Guide
Developer Guide
General
General
Querying data
Create
Update
Delete
Authentication
Assets
Tasks
Documents
Documents
Get/Find a document
Create a document
Create a folder
Modify document
Upload new version
Download a document file
Assemblies
Configuration
Configuration
Custom fields
Custom tabs
Custom tabs
Manage tabs
Manage tab fields
Manage values
Animations
Animations
Animations
Definition
RDS and data points
RDS and data points
RDS
Data points (RDS Variables)
SDKs
SDKs
Security Mobile App SDK
Security Manager Access PACS SDK
Resources
Resources
Power BI templates
Power BI templates
Operations and Energy
Operations and Energy
Overview
Tables
Contact
Industrial Operations X
Industrial Operations X
Overview
Industrial Operations X Products
Industrial Operations X APIs in API Catalog
Contact
ANYbotics
ANYbotics
Overview
Contact
Aviation Data Hub
Aviation Data Hub
Overview
Airport vertical
Airport vertical
REST API
Samples
Asset vertical
Asset vertical
REST API
Samples
Baggage vertical
Baggage vertical
REST API
Samples
Container vertical
Container vertical
REST API
Samples
Flight vertical
Flight vertical
REST API
Samples
Contact
Battery Passport
Battery Passport
Overview
Getting Started
Battery Passport Rest API
Changelog
FAQ
Contact
COMOS Web REST API
COMOS Web REST API
Overview
Get Started
COMOS Web REST API
FAQ
Logging
Versioning and Compatibility
Contact
DepotFinity
DepotFinity
Overview
APIs & Services
APIs & Services
General Information
Authorization
Authorization
Overview
Quick Start
API Reference
Charger Status API
Charger Status API
Overview
API Reference
Transactions API
Transactions API
Overview
API Reference
Session Reports API
Session Reports API
Overview
API Reference
Time Series API
Time Series API
Overview
API Reference
Force Termination API
Force Termination API
Overview
API Reference
RFID Management API
RFID Management API
Overview
API Reference
Remote Commands API
Remote Commands API
Overview
API Reference
API Reference
Version 2
Version 1
Reservations API
Reservations API
Overview
API Reference
Charger Control API
Charger Control API
Overview
API Reference
Virtual Power Plant API
Virtual Power Plant API
Overview
API Reference
VDV-261
VDV-261
Overview
API Reference
Contact
Digital Logistics
Digital Logistics
Carbon Footprint Indicator for Transportation API
Getting Started
Rest API
FAQ
Contact
Enlighted
Enlighted
Overview
Energy environment
Energy environment
Overview
Getting Started
Organization APIs
Organization APIs
Overview
Get Organization Details
Get All Campuses
Get All Buildings
Get All Floors
Get Floor Plan Image
Get Sensor Details by Floor API
Area APIs
Area APIs
Overview
Get All Areas
Get Area Energy Consumption
Set Area Emergency
Fixture APIs
Fixture APIs
Overview
Get Sensor Details
Get Sensor Details by Floor
Get All Fixtures by Area
Get Sensor Profiles
Assign Profile
Get Sensor Location by Floor
Get Sensor Energy Consumption
Get Sensor Energy Consumption by Area
Manual Override for a Fixture
Auto Mode for a Fixture
Get Fixture Dim Level by Floor
Gateway Details by Floor
Plugload APIs
Plugload APIs
Overview
Get Plugload Details
Get All Plugloads by Floor
Get All Plugloads by Area
Get All Plugload Controller Energy Consumption
Get All Plugload Energy Consumption by Area
Set Plugload Status
Conference APIs
Conference APIs
Overview
Get Switch Groups
Get Switch Scenes
Get Scene Light Levels for a Switch
Apply Scene
Manual Override for Switch Group
Data APIs
Data APIs
Overview
Get Energy Manager Aggregate Energy Consumption
Get Sensor Energy Data by Floor
Get Aggregate Sensor Energy Data by floor for last one hour
Get Aggregate Sensor Energy Data by Floor
Get BACnet Health
Demand Response APIs
Demand Response APIs
Overview
Schedule Demand Response for selected facilities
Schedule Demand Response for all facilities
Update Demand Response for selected facilities
Update Demand Response for all facilities
List Demand Response
Cancel Demand Response
BLE APIs
BLE APIs
Overview
Bluetooth Sensors by floor
Set BLE Mode for Sensor
Tunable White APIs
Tunable White APIs
Overview
Change color
Scene Control
Recall the Lighting Scene Color
DALI Emergency APIs
DALI Emergency APIs
Overview
Start the Functional or Duration Test for a Fixture
Driver Status to Normal (Stop Test)
Update Test Parameters for a Fixture
Get Fixture Status by Fixture
Get the List of Emergency Fixtures by Floor
Get Driver Test Parameters by Fixture
Set Emergency for all Fixtures
FAQ
Location services
Location services
Overview
Location services REST APIs
Location services REST APIs
Getting Started
Ping Connectivity
Fetch a Tag
Iterate Tags
Location services Streaming APIs
Location services Streaming APIs
Getting Started
Schema Overview
Data Types
Data Types
battery
button
error
floorExit
positional
refreshSuccess
tag
Event Types
Event Types
attention
battery
floorExit
getTagsFailure
motion
requestError
response
tagHeartBeat
tagInfo
tamper
zoneTransition
Command Types
Command Types
getTags
refreshCredentials
FAQ
Occupancy
Occupancy
Overview
Getting Started
Occupancy APIs
Occupancy APIs
Area Occupancy
Area Occupancy for a Floor
Real-time Desk Occupancy for a Floor
Detailed Fine-Grained Sensor Data
FAQ
Contact
Industrial Asset Hub
Industrial Asset Hub
Overview
Industrial Asset Hub APIs
Contact
Industrial Edge for Machine Tools
Industrial Edge for Machine Tools
Overview
Analyze MyWorkpiece /Capture4Analysis
Analyze MyWorkpiece /Monitor
Analyze MyMachine /Condition
Analyze MyMachine /Condition
Overview
API Specification
Manage MyAI
Automate MyVisual Inspection /Analyzer
Industrial Edge for Machine Tools in Insights Hub
Industrial Edge for Machine Tools APIs
Industrial Edge for Machine Tools App Sdk
Contact
Industrial Edge
Industrial Edge
Overview
Industrial Edge APIs
Open Source Projects
Contact
Industrial Information Hub
Industrial Information Hub
Overview
Industrial Information Hub APIs
Contact
Industrial IoT Open Source Tools and Libraries
Industrial IoT Open Source Tools and Libraries
Overview
MindConnect-NodeJs
MindConnect-NodeJs
Proxy Support
Troubleshooting
License
Agent Development
Agent Development
Retrying Operations
MindConnect Agent Methods
Starter Projects
Agent State Storage
TypeScript SDK
TypeScript SDK
Authorization
Using HttpAction
Contibuting to SDK
Command Line Interface
Command Line Interface
Setting Up the CLI
Development Proxy
Commands
Commands
mdsp agent-status Command
mdsp agent-token Command
mdsp aggregates Command
mdsp aspects Command
mdsp asset-info Command
mdsp asset-lock Command
mdsp asset-types Command
mdsp assets Command
mdsp cases Command
mdsp check-bulk Command
mdsp configure-agent Command
mdsp create-agent Command
mdsp create-event Command
mdsp data-exchange Command
mdsp data-lake Command
mdsp delete-asset Command
mdsp delete-file Command
mdsp delivery-jobs Command
mdsp dev-proxy Command
mdsp download-bulk Command
mdsp download-file Command
mdsp event-types Command
mdsp events-bulk Command
mdsp events Command
mdsp get-diagnostic Command
mdsp identity-management Command
mdsp jobs Command
mdsp list-assets Command
mdsp list-files Command
mdsp markdown-help Command
mdsp message-broker Command
mdsp mobile-app-instances Command
mdsp mobile-apps Command
mdsp models Command
mdsp mqtt-createjwt Command
mdsp notifications Command
mdsp oe-app-deploy Command
mdsp oe-app-inst Command
mdsp oe-deploy-workflow Command
mdsp oe-device-status Command
mdsp oe-device-types Command
mdsp oe-devices Command
mdsp oe-firm-deploy Command
mdsp offboard-agent Command
mdsp onboard Command
mdsp policy Command
mdsp prepare-bulk Command
mdsp register-diagnostic Command
mdsp renew-agent Command
mdsp run-bulk Command
mdsp schedules Command
mdsp sdi-data-lakes Command
mdsp sdi-data-queries Command
mdsp sdi-data-registries Command
mdsp sdi-data-types Command
mdsp sdi-execution-jobs Command
mdsp sdi-file-upload Command
mdsp sdi-ingest-jobs Command
mdsp sdi-iot-registries Command
mdsp sdi-ontologies Command
mdsp sdi-ontology-jobs Command
mdsp sdi-search-schemas Command
mdsp service-credentials Command
mdsp service-token Command
mdsp signal-calculation Command
mdsp starter-js Command
mdsp starter-ts Command
mdsp subtenants Command
mdsp tenant Command
mdsp timeseries Command
mdsp unregister-diagnostic Command
mdsp upload-file Command
mdsp upload-timeseries Command
mdsp visual-flow-creator Command
Authentication Helper
Authentication Helper
License
MindConnect Node-RED Node
MindConnect Node-RED Node
Getting Started
License
All Open Source Projects
Contact
Insights Hub and Industrial IoT
Insights Hub and Industrial IoT
Overview
Developer Documentation
Insights Hub and Industrial IoT APIs
Insights Hub and Industrial IoT SDKs and Libraries
Platform Core
Platform Core
Identity Management Service
Identity Management Service
Overview
Overview
Identity Management - Developer Documentation
APIs & References
APIs & References
API Specification
Resource Access Management
Resource Access Management
Overview
Concepts
Concepts
Definitions Structure
Understanding Policy effects
ABAC based Policiy Conditions
Quickstarts
Quickstarts
Create and Assign a Policy - Policy Manager
Assign a Policy - REST
Troubleshoot
Troubleshoot
Common Issues
Known Issues
References
References
Administration API Specification
Action List
Services & Required Actions
Limits
Message Broker Service
Message Broker Service
Overview
Topics
APIs & References
APIs & References
API Specification
Samples
OAuth Authorization Server API
OAuth Authorization Server API
Overview
APIs & References
APIs & References
API Specification
Tenant Management Service
Tenant Management Service
Overview
APIs & References
APIs & References
API Specification
Token Management Service
Token Management Service
Overview
APIs & References
APIs & References
API Specification
Samples
Usage Transparency Service
Usage Transparency Service
Overview
APIs & References
APIs & References
API Specification
Samples
IoT and Storage
IoT and Storage
IoT File Service
IoT File Service
Version 4.x - What's New?
Overview
APIs & References
APIs & References
Filtering
Multi Part Operations
Bulk Delete Operation
API Specification
IoT Time Series Service
IoT Time Series Service
IoT Time Series Service API
IoT Time Series Service API
Overview
Ingest Rate Calculator
APIs & References
APIs & References
API rate limits
API Specification
Samples
IoT Time Series Subscription Notification Async API
IoT Time Series Subscription Notification Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API - Europe 1
IoT TS Aggregates Service
IoT TS Aggregates Service
Version 4.x - What's New?
IoT TS Aggregates Service - V3.x to V4.x Migration Guide
Overview
Overview
Overview for v3.x
Overview for v4.x
Basics
Basics
Request Parameters for v3.x
Request Parameters for v4.x
APIs & References
APIs & References
Selecting
API Specification
Samples
Samples
Aggregate v3.x Samples
Aggregate v4.x Samples
IoT TS Bulk Service
IoT TS Bulk Service
Overview
APIs & References
APIs & References
API Specification
Samples
IoT Time Series Stream Registration Service
IoT Time Series Stream Registration Service
Overview
APIs & References
APIs & References
API Specification
Integrated Data Lake Service
Integrated Data Lake Service
Version 4.x - What's new?
Overview
Overview for v4.x
APIs & References
APIs & References
API Specification
Samples
Samples
Upload Data
Download Data
Config Events
Metadata
Metadata Management
Cross Account Accesses
Metadata & Object Search
Bulk Batch File Upload
Delete Multiple Objects
Time Series Import
Object and Folder Operations
Upload Large Files
Connectivity
Connectivity
Agent Management Service
Agent Management Service
Agent Management API
Agent Management API
Overview
APIs & References
APIs & References
API Specification
Usage quota and limits
Agent Management Async API
Agent Management Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API - Private Cloud
Async API - Europe 1
MindConnect
MindConnect
MindConnect API
MindConnect API
Overview
APIs & References
APIs & References
API Specification
Filtering
API Rate Limits
MindConnect Async API
MindConnect Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API - Europe 1
Async API - Private Cloud
Samples
MindConnect MQTT API
MindConnect MQTT API
Overview
APIs & References
APIs & References
API Specification
API Rate Limits
Asset Modeler Async API
Asset Modeler Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API v4.0.0 - Private Cloud
Async API v3.0.0 - Private Cloud
Async API v4.0.0 - Europe 1
Async API v3.1.0 - Europe 1
Samples
OPC UA PubSub Service
OPC UA PubSub Service
Overview
Basics
Basics
Data Model Mapping
Limits & Constraints
Samples
Samples
Samples for TimeSeries Metadata
Samples for TimeSeries Data
Samples for Event Metadata
Samples for Event Data
APIs & References
APIs & References
Async API Specification
Async API v4.0.0 - Europe 1
Async API v3.0.2 - Europe 1
Commanding Feature
Commanding Feature
Overview
APIs & References
APIs & References
API Specification
Async API - Europe 1
Async API - Private Cloud
API - Europe 1
Samples
Samples
Samples for subscribing to an MQTT topic
Samples for Publishing MQTT commands to agents
Remote Services
Remote Services
Overview
APIs & References
APIs & References
API Specification
Advanced
Advanced
Asset Management Service
Asset Management Service
Asset Management Service API
Asset Management Service API
Overview
APIs & References
APIs & References
Basic Types
Filtering
Pagination
API Rate Limits
API Specification
Samples
Samples
Modeling Assets
Modeling Hierarchical Asset Structures
Using Default Values
Update Asset Type
Asset Management Subscription Notification Async API
Asset Management Subscription Notification Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API - Europe 1
Samples
Event Management Service
Event Management Service
Event Management Service API
Event Management Service API
Overview
Event Count Estimator
APIs & References
APIs & References
Filtering
API Rate Limits
API Specification
Samples
Samples
Best Practices
Event Operations
Event Type Operations
Event Management Subscription Notification Async API
Event Management Subscription Notification Async API
Overview
APIs & References
APIs & References
Async API Specification
Async API v3.0.1
Samples
Notification Service
Notification Service
Overview
APIs & References
APIs & References
API Specification
Samples
Samples
Samples for v3.x
Samples for v4.x
Case Management Service
Case Management Service
Overview
APIs & References
APIs & References
Filtering
Pagination
API Specification
Samples
Visual Flow Creator
Visual Flow Creator
Overview
APIs & References
APIs & References
API Specification
Rules Management
Rules Management
Overview
APIs & References
APIs & References
API Specification
Analytics Services
Analytics Services
Data Exchange Service
Data Exchange Service
Overview
APIs & References
APIs & References
API Rate Limits
API Specification
Samples
Job Manager Service
Job Manager Service
Overview
APIs & References
APIs & References
API Rate Limits
API Specification
Samples
Model Management Service
Model Management Service
Overview
APIs & References
APIs & References
API Rate Limits
API Specification
Samples
Data Contextualization
Data Contextualization
Data Management
Data Management
Overview
APIs & References
APIs & References
API Specification
Samples
Data Query
Data Query
Overview
APIs & References
APIs & References
API Specification
Semantic Modelling
Semantic Modelling
Overview
APIs & References
APIs & References
API Specification
Resources
Resources
Insights Hub Monitor Plugin
Insights Hub Monitor Plugin
Getting started
References
Demo Plugin
Checklist
FAQ
Change Log
MindConnect Library v3
MindConnect Library v3
Developer Documentation
Getting started
Getting started
Linux
Windows
Interfaces and References
Samples
Certificate
Change Log
MindConnect Library v4
MindConnect Library v4
Developer Documentation
Dependencies
Replacing MCL Modules
Building MCL
Agent Application
Examples
Reference Document
Sony Spresense Guide
Migrating From 3.x To 4.x
Certificate
Change Log
OS Bar
Industrial IoT SDK for Java
Industrial IoT SDK for Java
Getting started
Exception Handling
Logging
API clients and References
Code samples
Code samples
Asset Management
Event Analytics
Event Management
IoT File
IoT Time Series
IoT TS Aggregate
Industrial IoT SDK V2 for Java
Industrial IoT SDK V2 for Java
Getting started
Exception Handling
Token Handling
Logging
API clients and References
Code samples
Code samples
Agent Management
Asset Management
Event Analytics
Event Management
IoT File
IoT Time Series
IoT TS Aggregate
IoT TS Aggregate V4.X
Insights Hub Credentials
Token Management
MindConnect
IoT Time Series
IOT Bulk
IoT TS Aggregate V4.X
Integrated Data Lake
Industrial IoT SDK for Node.js
Industrial IoT SDK for Node.js
Getting started
Token Handling
Logging
API clients and References
Code samples
Code samples
Asset Management
Event Analytics
IoT File
IoT Time Series
IoT TS Aggregate
IoT TS Aggregates Client for node
Insights Hub Credentials
Industrial IoT SDK for Python
Industrial IoT SDK for Python
Getting started
Error Handling
Token Handling
Logging
API clients and References
Code samples
Code samples
Asset Management
IoT Time Series*
IoT TS Aggregate*
IoT TS Aggregate V4.X*
IoT File
Event Analytics
IoT Time Series
IoT TS Bulk
MindConnect
Insights Hub Credentials
Data Contextualization
Integrated Data Lake
Contact
Mcenter
Mcenter
Overview
Contact
Nurse Call System API
Nurse Call System API
Overview
Getting Started
NCS Rest API
Changelog
Contact
OT Companion
OT Companion
Overview
APIs & Services
APIs & Services
Asset Management API
Asset Management API
Overview
API Specification
Protection Settings API
Protection Settings API
Overview
API Specification
Contact
PlantSight
PlantSight
Overview
PlantSight Digital Enablement
PlantSight Digital Enablement
APIs
COMOS Walkinside Service
COMOS Walkinside Service
Project and User management APIs
Project and User management APIs
API Specification
Contact
PLM Components
PLM Components
Overview
All PLM Components
Contact
Polarion
Polarion
Introduction
Enable REST API
Access REST API
Authentication
Authorization
Basic Concepts
Scenarios and Advanced Concepts
Advanced Configuration
Limitations and Known Issues
Polarion REST API
Polarion SDK
Contact
Product Information Hub
Product Information Hub
Overview
Getting Started
Rest API
Changelog
FAQ
Contact
Railigent X
Railigent X
Overview
Contact
API Catalog
Train API
Train API
Train API Changelog
Train API v1 Specification
SieSmart
SieSmart
Overview
Get Started
Get Started
Configuration
Common scenarios
Common scenarios
Create a proposal
Submit for a decision
Notifications/WebHooks
Insights
REST APIs
REST APIs
API URLs
Authentication
API Spec
Contact Us
Changelog
SiGREEN
SiGREEN
Overview
Getting Started
SiGREEN APIs
SiGREEN APIs
Procurement API(s)
Procurement API(s)
Quick Start
API Reference
Changelog
Product API(s)
Product API(s)
Quick Start
API Reference
Changelog
My Tasks API(s)
My Tasks API(s)
Quick Start
API Reference
Changelog
PCF (Beta) APIs
PCF (Beta) APIs
API Reference
Changelog
Validation Errors
Concepts and Glossary
Contact
SIMATIC AX
SIMATIC AX
Overview
Developer Documentation
SIMATIC AX Open Source Community
Contact
SITRANS SCM IQ
SITRANS SCM IQ
Overview
Getting Started
API Reference
Contact
Teamcenter (X) Product Cost Management
Teamcenter (X) Product Cost Management
Overview
Getting Started
Securing with certificates
FAQ
REST API
Versions
Contact
Workflow Canvas
Workflow Canvas
Overview
Contact
Transaction Management API
¶
Back to top
