aid: siemens url: https://raw.githubusercontent.com/api-search/siemens/refs/heads/main/apis.yml apis: - aid: siemens:airport-vertical-api name: Siemens Airport Vertical API humanURL: https://developer.siemens.com/adh/airport-vertical/index.html properties: - url: https://developer.siemens.com/adh/airport-vertical/index.html type: Documentation description: >- Siemens Airport Vertical API is a software solution that helps airports streamline their operations and improve efficiency. It provides a set of tools and functionalities that allow airports to optimize their processes, such as baggage handling, passenger flow, and aircraft turnaround times. The API integrates with existing airport systems to provide real-time data and insights, enabling airports to make data-driven decisions and enhance the overall passenger experience. - aid: siemens:asset-vertical-api name: Siemens Asset Vertical API humanURL: https://developer.siemens.com/adh/asset-vertical/index.html properties: - url: https://developer.siemens.com/adh/asset-vertical/index.html type: Documentation description: >- Siemens Asset Vertical API is a powerful tool that allows users to access and manage asset data across a wide range of industries. By providing a standardized interface for interacting with assets, this API enables seamless integration with various software applications and systems. Users can easily retrieve information about asset performance, maintenance schedules, and other critical data points, allowing for improved decision-making and operational efficiency. - aid: siemens:baggage-vertical-api name: Siemens Baggage Vertical API humanURL: https://developer.siemens.com/adh/baggage-vertical/index.html properties: - url: https://developer.siemens.com/adh/baggage-vertical/index.html type: Documentation description: >- Siemens Baggage Vertical API is a sophisticated software interface that allows airport operators to seamlessly integrate with their baggage handling systems. This API provides real-time data on the status and location of baggage, enabling airport staff to track and manage the movement of luggage efficiently and effectively. - aid: siemens:container-vertical-api name: Siemens Container Vertical API humanURL: https://developer.siemens.com/adh/container-vertical/index.html properties: - url: https://developer.siemens.com/adh/container-vertical/index.html type: Documentation description: >- The Siemens Container Vertical API is a software interface that allows for seamless integration and communication between Siemens containers and vertical systems. This API enables users to easily access and manage data within their containers, such as monitoring and controlling various processes, sensors, and equipment. By utilizing this API, users can automate tasks, streamline operations, and improve overall efficiency within their container systems. - aid: siemens:flight-vertical-api name: Siemens Flight Vertical API humanURL: https://developer.siemens.com/adh/flight-vertical/index.html properties: - url: https://developer.siemens.com/adh/flight-vertical/index.html type: Documentation description: >- Siemens Flight Vertical API is a sophisticated software interface that provides real-time data and analytics to streamline air travel operations. By integrating with various systems such as flight planning, scheduling, and tracking, this API enables airlines and airports to optimize their flight operations, improve efficiency, and enhance the overall passenger experience. - aid: siemens:anymal-api-and-sdk name: Siemens ANYmal API and SDK humanURL: https://developer.siemens.com/anybotics/overview.html properties: - url: https://developer.siemens.com/anybotics/overview.html type: Documentation description: >- The Siemens ANYmal API and SDK are tools that enable users to easily integrate the ANYmal robotic platform into their projects and applications. The API allows developers to control and interact with ANYmal's hardware and software components, such as sensors, motors, and algorithms, programmatically. This provides flexibility and customization options for users to create advanced functionalities and applications for the ANYmal robot. - aid: siemens:battery-passport-rest-api name: Siemens Battery Passport REST API humanURL: https://developer.siemens.com/battery-passport/overview.html properties: - url: https://developer.siemens.com/battery-passport/overview.html type: Documentation description: >- Siemens Battery Passport REST API is a powerful tool that allows users to access and manage battery information in real-time. With this API, users can retrieve data on battery performance, health, and status, as well as track key metrics such as voltage, temperature, and charging cycles. Additionally, the API enables users to monitor multiple batteries simultaneously, making it ideal for businesses and organizations with large battery fleets. - aid: siemens:building-operations-api name: Siemens Building Operations API humanURL: >- https://developer.siemens.com/building-x-openness/api/building-operations/overview.html baseURL: https://buildingx.siemens.com/api/v1 properties: - url: >- https://developer.siemens.com/building-x-openness/api/building-operations/overview.html type: Documentation - url: openapi/siemens-building-operations-openapi.yml type: OpenAPI - url: rules/siemens-rules.yml type: SpectralRules - url: capabilities/building-operations.yaml type: Capabilities - url: json-schema/siemens-building-point-schema.json type: JSONSchema - url: json-ld/siemens-context.jsonld type: JSONLD - url: vocabulary/siemens-vocabulary.yml type: Vocabulary description: >- The Siemens Building Operations API is a powerful tool that allows developers to integrate and customize building automation systems. This API enables communication between different building management systems and third-party software applications, giving users greater control and flexibility in managing their properties. With the Siemens Building Operations API, developers can create custom dashboards, automate routine tasks, and optimize energy usage for increased efficiency and cost savings. - aid: siemens:building-structure-api name: Siemens Building Structure API humanURL: >- https://developer.siemens.com/building-x-openness/api/building-structure/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/building-structure/overview.html type: Documentation description: >- Siemens Building Structure API is a software interface that allows users to access and interact with various building management systems and devices within a structure. This API enables developers to create custom applications and integrations that can control and monitor a wide range of building functions, such as HVAC systems, lighting, security, and energy management. - aid: siemens:accounts-api name: Siemens Accounts API humanURL: >- https://developer.siemens.com/building-x-openness/api/accounts-api/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/accounts-api/overview.html type: Documentation description: >- The Siemens Accounts API is a powerful tool that allows developers to interact with Siemens' account management system programmatically. With this API, users can create, update, and manage user accounts, as well as assign roles and permissions to different users. The API also enables developers to retrieve information about users, such as their contact details and activity history. - aid: siemens:fire-api name: Siemens Fire API humanURL: https://developer.siemens.com/building-x-openness/api/fire/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/fire/overview.html type: Documentation description: >- Siemens Fire API is a software application programming interface that enables integration and communication between Siemens' fire safety systems and third-party software and applications. It allows users to access and control various functions of Siemens fire safety systems, such as alarm monitoring, device status monitoring, event logging, and system configuration, through a standardized set of programming instructions. - aid: siemens:security-activities-api name: Siemens Security Activities API humanURL: >- https://developer.siemens.com/building-x-openness/api/security-api/activities-v1/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/security-api/activities-v1/overview.html type: Documentation description: >- Siemens Security Activities API is a comprehensive software tool designed to enhance the security of various digital devices and systems. This API allows users to seamlessly integrate advanced security measures into their applications, network infrastructure, and other virtual environments. - aid: siemens:security-identities-and-privileges-api name: Siemens Security Identities and Privileges API humanURL: >- https://developer.siemens.com/building-x-openness/api/security-api/piam-v1/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/security-api/piam-v1/overview.html type: Documentation description: >- Siemens Security Identities and Privileges API is a powerful tool that provides secure access control and management of user identities within an organization's systems. This API allows administrators to define user roles, permissions, and privileges, ensuring that sensitive data and resources are protected from unauthorized access. - aid: siemens:point-value-ingest-api name: Siemens Point Value Ingest API humanURL: >- https://developer.siemens.com/building-x-openness/api/point-value-ingest-api/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/point-value-ingest-api/overview.html type: Documentation description: >- Siemens Point Value Ingest API is a platform that enables users to easily and efficiently ingest large volumes of data into their system. This API allows for seamless integration of data from various sources, such as sensors, industrial equipment, and monitoring devices, into the user's system. - aid: siemens:building-geometry-api name: Siemens Building Geometry API humanURL: >- https://developer.siemens.com/building-x-openness/api/geometry-api/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/geometry-api/overview.html type: Documentation description: >- Siemens Building Geometry API is a powerful tool that allows developers to access and manipulate the geometric data of building models. By using this API, users can extract information such as room dimensions, wall angles, and window locations to help streamline the design and construction process. With this data, designers can create more accurate and efficient building models, leading to better decision-making and ultimately, more successful projects. - aid: siemens:energy-api name: Siemens Energy API humanURL: >- https://developer.siemens.com/building-x-openness/api/energy-api/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/energy-api/overview.html type: Documentation description: >- Siemens Energy API is a platform that offers a range of application programming interfaces (APIs) to enable seamless integration of Siemens Energy solutions with various external systems and applications. These APIs facilitate communication and data exchange between Siemens Energy products and third-party software, allowing for enhanced functionality, automation, and customization. - aid: siemens:lifecycle-twin-api name: Siemens Lifecycle Twin API humanURL: >- https://developer.siemens.com/building-x-openness/api/lifecycletwin-api/overview.html properties: - url: >- https://developer.siemens.com/building-x-openness/api/lifecycletwin-api/overview.html type: Documentation description: >- Siemens Lifecycle Twin API is a comprehensive software platform that allows users to create digital replicas, or twins, of physical products or systems throughout their entire lifecycle. This API provides tools for creating, managing, and analyzing data from these digital twins, enabling users to monitor and optimize performance, predict maintenance needs, and simulate different scenarios to improve overall efficiency and effectiveness. - aid: siemens:comos-web-rest-api name: Siemens COMOS Web REST API humanURL: https://developer.siemens.com/comos/overview.html properties: - url: https://developer.siemens.com/comos/overview.html type: Documentation description: >- Siemens COMOS Web REST API is a tool that allows users to interact with the COMOS engineering software platform through web services. This API enables seamless integration with external systems, allowing for the transfer of data and information from COMOS to other applications and vice versa. With the REST API, users can access various functionalities such as creating, updating, and deleting objects, as well as querying and retrieving data. - aid: siemens:charger-status-api name: Siemens Charger Status API humanURL: >- https://developer.siemens.com/depotfinity/ChargerStatusAPI/charger_status_api.html properties: - url: >- https://developer.siemens.com/depotfinity/ChargerStatusAPI/charger_status_api.html type: Documentation description: >- The Siemens Charger Status API is a tool that allows users to monitor and track the status of Siemens charging stations in real-time. This API provides information on the availability, location, and usage of charging stations, enabling users to easily check for updates on station availability, make informed decisions on where to charge their electric vehicles, and plan their charging schedules accordingly. - aid: siemens:charger-control-api name: Siemens Charger Control API humanURL: >- https://developer.siemens.com/depotfinity/ChargerControlAPI/charger_control_api.html properties: - url: >- https://developer.siemens.com/depotfinity/ChargerControlAPI/charger_control_api.html type: Documentation description: >- The Siemens Charger Control API is a software interface that allows users to remotely manage and control Siemens charging infrastructure. This includes monitoring the charging status of electric vehicles, managing charging schedules, and adjusting charging settings to optimize performance and efficiency. The API provides real-time data on energy consumption, battery levels, and charging progress, allowing users to make informed decisions about their charging operations. - aid: siemens:remote-command-api name: Siemens Remote Command API humanURL: >- https://developer.siemens.com/depotfinity/RemoteCommandAPI/remote_command_api.html properties: - url: >- https://developer.siemens.com/depotfinity/RemoteCommandAPI/remote_command_api.html type: Documentation description: >- The Siemens Remote Command API is a software tool that allows users to remotely access and control Siemens programmable logic controllers (PLCs) and other industrial automation devices. With this API, users can send commands, retrieve data, and monitor the status of their machines from a centralized location. This enables users to remotely troubleshoot and adjust their equipment, saving time and reducing the need for on-site maintenance. - aid: siemens:reservations-api name: Siemens Reservations API humanURL: >- https://developer.siemens.com/depotfinity/ReservationsAPI/reservations_api.html properties: - url: >- https://developer.siemens.com/depotfinity/ReservationsAPI/reservations_api.html type: Documentation description: >- Siemens Reservations API is a powerful tool that allows users to make and manage reservations for various services offered by Siemens. This API enables users to easily book appointments, schedule maintenance checks, reserve conference rooms, and much more. It provides a seamless and efficient way for customers to interact with Siemens' booking system, reducing the time and effort required to make reservations. - aid: siemens:rfid-management-api name: Siemens RFID Management API humanURL: >- https://developer.siemens.com/depotfinity/RFIDManagementAPI/rfid_management_api.html properties: - url: >- https://developer.siemens.com/depotfinity/RFIDManagementAPI/rfid_management_api.html type: Documentation description: >- The Siemens RFID Management API is a software tool that allows users to manage and track RFID tags and readers. This API enables users to interact with their RFID devices, such as configuring settings, reading tag data, and monitoring device status. By using the Siemens RFID Management API, businesses can efficiently integrate RFID technology into their operations, improving inventory management, asset tracking, and security. - aid: siemens:transaction-management-api name: Siemens Transaction Management API humanURL: >- https://developer.siemens.com/depotfinity/TransactionManagementAPI/transaction_management_api.html properties: - url: >- https://developer.siemens.com/depotfinity/TransactionManagementAPI/transaction_management_api.html type: Documentation description: >- Siemens Transaction Management API is a powerful tool that enables businesses to securely and efficiently manage their financial transactions. With this API, companies can easily process payments, monitor transactions in real-time, and track payment history. The API also provides robust security features to protect sensitive financial data, including encryption and authentication mechanisms. - aid: siemens:vdv-261-api name: Siemens VDV-261 API humanURL: https://developer.siemens.com/depotfinity/VDV261/vdv261_api.html properties: - url: https://developer.siemens.com/depotfinity/VDV261/vdv261_api.html type: Documentation description: >- The Siemens VDV-261 API is a powerful tool designed to provide seamless integration and communication between various Siemens devices and systems. This API allows for efficient data exchange, configuration, and control of Siemens VDV-261 devices, enabling streamlined operations and enhanced functionality. - aid: siemens:drivetrain-analyzer-cloud-api name: Siemens Drivetrain Analyzer Cloud API humanURL: https://developer.siemens.com/dta/overview.html properties: - url: https://developer.siemens.com/dta/overview.html type: Documentation description: >- Siemens Drivetrain Analyzer Cloud API is a powerful tool that allows users to access and analyze data from their drivetrain systems remotely. This API enables users to monitor the performance and efficiency of their drivetrains, track maintenance schedules, and identify potential issues before they become serious problems. - aid: siemens:edge-app-sdk name: Siemens Edge App SDK humanURL: https://developer.siemens.com/edge-app-sdk/overview.html properties: - url: https://developer.siemens.com/edge-app-sdk/overview.html type: Documentation description: >- Siemens Edge App SDK is a software development kit that allows developers to create custom applications for Siemens Industrial Edge devices. This platform provides a comprehensive set of tools and resources for building and deploying edge computing applications in an efficient and scalable manner. With the Edge App SDK, developers can easily access data from sensors and machines, analyze it in real-time, and take responsive actions to optimize industrial processes. - aid: siemens:occupancy-apis name: Siemens Occupancy APIs humanURL: https://developer.siemens.com/enlighted-apis/occupancy/overview.html properties: - url: https://developer.siemens.com/enlighted-apis/occupancy/overview.html type: Documentation description: >- Siemens Occupancy APIs provide a platform for users to access real-time data on space utilization within buildings. These APIs utilize sensors and devices installed throughout a building to monitor occupancy levels and movement patterns. By aggregating and analyzing this data, users can gain insights into how spaces are being utilized, identify trends, and optimize their facility management strategies. - aid: siemens:location-services-apis name: Siemens Location Services APIs humanURL: >- https://developer.siemens.com/enlighted-apis/location-services/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/location-services/overview.html type: Documentation description: >- Siemens Location Services APIs provide developers with a comprehensive set of tools to integrate location-based services into their applications. These APIs allow developers to access real-time location data, track assets and monitor the movement of people and vehicles. With Siemens Location Services APIs, developers can create personalized, interactive maps, geofencing capabilities, and location-based notifications. - aid: siemens:organization-apis name: Siemens Organization APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/organization/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/organization/overview.html type: Documentation description: >- Siemens Organization APIs is a software platform that provides developers with access to a wide range of tools and resources to help them build and integrate applications with Siemens products and services. These APIs allow developers to tap into the vast ecosystem of Siemens technology, enabling them to create custom solutions tailored to their specific needs. - aid: siemens:area-apis name: Siemens Area APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/area/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/area/overview.html type: Documentation description: >- Siemens Area APIs is a software tool designed to transform the way we interact with industrial automation systems. By providing a set of standardized interfaces, Siemens Area APIs allow for seamless integration of different software applications and devices, enabling more efficient and flexible control over manufacturing processes. This sophisticated platform enables users to access and manipulate data from various sources, facilitating real-time monitoring, analysis, and decision-making. - aid: siemens:sensor-apis name: Siemens Sensor APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/fixtures/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/fixtures/overview.html type: Documentation description: >- Siemens Sensor APIs are a set of tools and interfaces that allow developers to easily access and integrate sensor data from various Siemens devices, such as programmable logic controllers (PLCs) and industrial sensors, into their own applications. These APIs provide a standardized way to communicate with Siemens sensors, enabling developers to collect real-time data on things like temperature, pressure, and motion. - aid: siemens:plugload-apis name: Siemens Plugload APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/plugload/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/plugload/overview.html type: Documentation description: >- Obtain Plugload details by floor or area including energy consumption, and status. - aid: siemens:sensor-bluetooth-apis name: Siemens Sensor Bluetooth APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/ble/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/ble/overview.html type: Documentation description: >- Obtain the list of BLE sensors and set BLE Mode for sensors. - aid: siemens:conference-room-apis name: Siemens Conference Room APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/conference-room/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/conference-room/overview.html type: Documentation description: >- Control lights in a conference room using scenes. - aid: siemens:tunable-white-apis name: Siemens Tunable White APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/tunable-white/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/tunable-white/overview.html type: Documentation description: >- Set color temperature and light level for Tunable White fixtures. - aid: siemens:data-apis name: Siemens Data APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/data/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/data/overview.html type: Documentation description: >- Get energy savings, temperature, light levels and power for all sensors on a floor. - aid: siemens:dali-emergency-apis name: Siemens DALI Emergency APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/dali-emergency/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/dali-emergency/overview.html type: Documentation description: >- Send emergency lighting commands, get emergency status from sensors, and test emergency drivers. - aid: siemens:demand-response-apis name: Siemens Demand Response APIs humanURL: >- https://developer.siemens.com/enlighted-apis/energy-environment/demand-response/overview.html properties: - url: >- https://developer.siemens.com/enlighted-apis/energy-environment/demand-response/overview.html type: Documentation description: >- Contribute to energy load reduction and savings during peak demand time and public holidays. - aid: siemens:inventory-api name: Siemens Inventory API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#inventory-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#inventory-api" type: Documentation description: >- Documentation of the API used to manage the Asset Models, which work as entry point for any further interaction with the assets. - aid: siemens:device-discovery-api name: Siemens Device Discovery API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#discovery-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#discovery-api" type: Documentation description: >- Documentation of the API used to trigger the Device Discovery, which is necessary to find devices. - aid: siemens:gateway-onboarding-api name: Siemens Gateway Onboarding API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#gw-onboarding-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#gw-onboarding-api" type: Documentation description: >- Documentation of the API used to onboard new gateways into CDM. - aid: siemens:authorization-api name: Siemens Authorization API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#authorization-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#authorization-api" type: Documentation description: >- Industrial Asset Hub Authorization API. - aid: siemens:user-configuration-api name: Siemens User Configuration API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#user-configuration-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#user-configuration-api" type: Documentation description: >- Industrial Asset Hub User Configuration API. - aid: siemens:workflow-executor-api name: Siemens Workflow Executor API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#workflow-executor-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#workflow-executor-api" type: Documentation description: >- Southbound API of the WFX (Workflow Executor) Service. - aid: siemens:remote-access-api name: Siemens Remote Access API humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#remote-access-api" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/programing-interface/programing-interface.html#remote-access-api" type: Documentation description: >- Industrial Asset Hub Remote Access API. - aid: siemens:industrial-asset-link name: Siemens Industrial Asset Link humanURL: >- https://developer.siemens.com/"https://industrial-assets.io/developers/getting-started/iah-compose-stack/index.html" properties: - url: >- https://developer.siemens.com/"https://industrial-assets.io/developers/getting-started/iah-compose-stack/index.html" type: Documentation description: >- Asset links act as adapters/drivers, between the Asset Gateway and the field devices. This SDK already includes the gRPC interfaces for the IAH use cases. - aid: siemens:ie-portal-api name: Siemens IE Portal API humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-management/ie-portal-api/1.5.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-management/ie-portal-api/1.5.0" type: Documentation description: >- Use the IEM API to automate tasks, such as IED onboarding or Industrial Edge Application management. - aid: siemens:admin-user-api name: Siemens Admin User API humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-management/admin-user-api/1.0.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-management/admin-user-api/1.0.0" type: Documentation description: >- This document provides API specs for Admin user. The specification is compatible starting from version 1.4.3 of the IEM. - aid: siemens:ie-device-api name: Siemens IE Device API humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/ie-device-api/2.0.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/ie-device-api/2.0.0" type: Documentation description: >- IE Device APIs offer the possibility to manage the lifecycle of the IE Device itself, list its resources and publish notifications. - aid: siemens:secure-storage-api name: Siemens Secure Storage API humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/secure-storage-api/2.0.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/secure-storage-api/2.0.0" type: Documentation description: >- The application stores data in secure storage in key-value pairs, where the unique key is used to identify each value. An application can have multiple key-value pairs, where each key is unique to its own application. Each application has a unique set of key-value pairs. - aid: siemens:ie-device-oidc-provider-api name: Siemens IE Device OIDC Provider API humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/ie-device-oidc-provider-api/1.0.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/industrial-edge-device/ie-device-oidc-provider-api/1.0.0" type: Documentation description: >- IE Device OIDC provider APIs offer the possibility to manage OIDC provider. - aid: siemens:network-service name: Siemens Network Service humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- The Network Service is a gRPC & Go based network configuration service. The network settings of the Edge Devices are configured through this service. - aid: siemens:ntp-service name: Siemens NTP Service humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- The NTP Service is a gRPC & Go based NTP configurator microservice for Edge Devices. - aid: siemens:onboard-service name: Siemens Onboard Service humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- The Onboard Service is a gRPC & Go based Edge Core activator. This service communicates with all other services and provides the necessary configurations for the Edge Device to successfully onboard. - aid: siemens:system-service name: Siemens System Service humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- The System Service is a gRPC & Go based system resource tracker and system controller. - aid: siemens:security-service name: Siemens Security Service humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- Protocol Documentation. - aid: siemens:industrial-edge-data-processing-apis name: Siemens Industrial Edge Data Processing APIs humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/intro/build-your-use-case/data-processing/data-processing-overview/data-processing-overview" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/intro/build-your-use-case/data-processing/data-processing-overview/data-processing-overview" type: Documentation description: >- Leverage Southbound and Nortbound connectivity of Industrial Edge and distribute data to various systems. - aid: siemens:iectl-industrial-edge-control name: Siemens IECTL - Industrial Edge Control humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/industrial-edge-control-iectl/overview/industrial-edge-control-iectl-overview" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/industrial-edge-control-iectl/overview/industrial-edge-control-iectl-overview" type: Documentation description: >- Industrial Edge Control (IECTL) is a Command Line Interface to interact with Industrial Edge and its components. - aid: siemens:flow-creator-configurator-apis name: Siemens Flow Creator Configurator APIs humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/flow-creator/flow-creator-configurator-api/2.0.0" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/flow-creator/flow-creator-configurator-api/2.0.0" type: Documentation description: >- The Flow Creator Configurator REST APIs allow you to configure flows, files, and nodes on Flow Creator instances running on multiple IE devices. - aid: siemens:service-registry-apis name: Siemens Service Registry APIs humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/service-registry/rest-api/service-registry-apis" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/service-registry/rest-api/service-registry-apis" type: Documentation description: >- Public API documentation for IE Runtime Service Registry. Service Registry serves as a centralized directory where information about available services and their locations is stored. - aid: siemens:vision-payload-specification name: Siemens Vision Payload Specification humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/point-to-point/vision-payload-specification" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/point-to-point/vision-payload-specification" type: Documentation description: >- Image Connector Applications Interface Specification. - aid: siemens:server-api-device-discover-api name: 'Siemens Server API: Device Discover API' humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/device-dicovery-api/device-discover-api" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/device-dicovery-api/device-discover-api" type: Documentation description: ' ' - aid: siemens:server-api-driver-event-api name: 'Siemens Server API: Driver Event API' humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/driver-event-api/driver-event-api" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/driver-event-api/driver-event-api" type: Documentation description: ' ' - aid: siemens:server-api-driver-info-api name: 'Siemens Server API: Driver Info API' humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/driver-info-api/driver-info-api" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/driver-info-api/driver-info-api" type: Documentation description: ' ' - aid: siemens:server-api-generic-data-api name: 'Siemens Server API: Generic Data API' humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/generic-data-api/generic-data-api" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/server-api/generic-data-api/generic-data-api" type: Documentation description: ' ' - aid: siemens:client-api-registry-api name: 'Siemens Client API: Registry API' humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/client-api/registry-api/registry-api" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/profinet-asset-service/api/client-api/registry-api/registry-api" type: Documentation description: ' ' - aid: siemens:undefined humanURL: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/databus/common-payload-definition" properties: - url: >- https://developer.siemens.com/"https://docs.industrial-operations-x.siemens.cloud/r/en-us/industrial-edge-platform-operation/apis-references/apis/databus/common-payload-definition" type: Documentation description: >- The Industrial Edge Common Databus Payload Format describes how connectors of different sources should publish data to the Databus. - aid: siemens:industrial-information-hub-essentials-api name: Siemens Industrial Information Hub Essentials API humanURL: >- https://developer.siemens.com/"https://docs.eu1.edge.siemens.cloud/apis_and_references/apis/iih-essentials/definitions/iih-essentials-2.0.0.html" properties: - url: >- https://developer.siemens.com/"https://docs.eu1.edge.siemens.cloud/apis_and_references/apis/iih-essentials/definitions/iih-essentials-2.0.0.html" type: Documentation description: >- Interact with the different endpoints of the IIH Essentials. - aid: siemens:industrial-iot-typescript-sdk name: Siemens Industrial IoT Typescript SDK humanURL: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/sdk/index.html properties: - url: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/sdk/index.html type: Documentation description: >- TypeScript/JavaScript Community SDK for Industrial IoT APIs. - aid: siemens:industrial-iot-command-line-interface name: Siemens Industrial IoT Command Line Interface humanURL: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/cli/index.html properties: - url: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/cli/index.html type: Documentation description: >- Command Line Interface for Industrial IoT APIs. - aid: siemens:undefined humanURL: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/index.html properties: - url: >- https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/index.html type: Documentation description: >- Starting point for custom field to cloud connectivity implementation in node.js. - aid: siemens:mindconnect-node-red-node name: Siemens MindConnect Node-RED Node humanURL: >- https://developer.siemens.com/industrial-iot-open-source/node-red-contrib-mindconnect/index.html properties: - url: >- https://developer.siemens.com/industrial-iot-open-source/node-red-contrib-mindconnect/index.html type: Documentation description: >- A Node-RED node which can be used to upload the time series data, files and events to the cloud. - aid: siemens:authentication-helper name: Siemens Authentication Helper humanURL: >- https://developer.siemens.com/industrial-iot-open-source/mindsphere-auth-helper/index.html properties: - url: >- https://developer.siemens.com/industrial-iot-open-source/mindsphere-auth-helper/index.html type: Documentation description: >- Chrome extension which simplifies development tasks for which you need to use the SESSION and XSRF-TOKEN to access Industrial IoT APIs. - aid: siemens:identity-management-service name: Siemens Identity Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-identitymanagement/api-identitymanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-identitymanagement/api-identitymanagement-overview.html type: Documentation description: >- Manages Environments, users and groups within Insights Hub. - aid: siemens:resource-access-management name: Siemens Resource Access Management humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-resourceaccessmanagement/api-resourceaccessmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-resourceaccessmanagement/api-resourceaccessmanagement-overview.html type: Documentation description: >- Secure Data Sharing (SDS) enables you to create and manage fine-grained access rights. - aid: siemens:message-broker-service name: Siemens Message Broker Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-messagebroker/api-messagebroker-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-messagebroker/api-messagebroker-overview.html type: Documentation description: >- Message Broker is a service that enables asynchronous communication in the Industrial IoT platform. - aid: siemens:oauth-authorization-server name: Siemens Oauth Authorization Server humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-oauthauthorizationserver/api-oauthauthorizationserver-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-oauthauthorizationserver/api-oauthauthorizationserver-overview.html type: Documentation description: >- The OAuth Authorization Server provides APIs for authentication and authorization. - aid: siemens:tenant-management-service name: Siemens Tenant Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-tenantmanagement/api-tenantmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-tenantmanagement/api-tenantmanagement-overview.html type: Documentation description: >- A service to manage an environment (tenant), its related subtenants, as well as related data. - aid: siemens:token-management-service name: Siemens Token Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/exchange-tokenmanager/api-tokenmanager-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/exchange-tokenmanager/api-tokenmanager-overview.html type: Documentation description: >- Grant your application access to tenant data. - aid: siemens:usage-transparency-service name: Siemens Usage Transparency Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/core-usagetransparency/api-usagetransparency-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/core-usagetransparency/api-usagetransparency-overview.html type: Documentation description: >- Information about ap usage for billing, reporting and quota checking purposes. - aid: siemens:iot-file-service name: Siemens IoT File Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iotfile/api-iotfile-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iotfile/api-iotfile-overview.html type: Documentation description: >- File management for files related to assets. - aid: siemens:iot-time-series-service name: Siemens IoT Time Series Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottimeseries/api-iottimeseries-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottimeseries/api-iottimeseries-overview.html type: Documentation description: >- Create, read update and delete time series data. - aid: siemens:iot-time-series-subscription name: Siemens IoT Time Series Subscription humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottimeseries/api-subscription-notification-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottimeseries/api-subscription-notification-overview.html type: Documentation description: >- Notification about arrival of new time series data. - aid: siemens:iot-time-series-aggregates-service name: Siemens IoT Time Series Aggregates Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottsaggregates/api-iottsaggregates-overview-v4.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottsaggregates/api-iottsaggregates-overview-v4.html type: Documentation description: >- Aggregated summaries of numeric time series data. - aid: siemens:iot-time-series-bulk-service name: Siemens IoT Time Series Bulk Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottsbulk/api-iottsbulk-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-iottsbulk/api-iottsbulk-overview.html type: Documentation description: >- Import large amounts of data into Insights Hub. - aid: siemens:integrated-data-lake-service name: Siemens Integrated Data Lake Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/iot-integrated-data-lake/api-integrated-data-lake-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/iot-integrated-data-lake/api-integrated-data-lake-overview.html type: Documentation description: >- Store structured and unstructured data in its native format. - aid: siemens:agent-management-service name: Siemens Agent Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-agentmanagement/api-agentmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-agentmanagement/api-agentmanagement-overview.html type: Documentation description: >- API to onboard, offboard, update and delete agents. - aid: siemens:agent-management-async-api name: Siemens Agent Management Async API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-agentmanagement-async/api-agentmanagement-async-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-agentmanagement-async/api-agentmanagement-async-overview.html type: Documentation description: >- API to onboard, offboard, update and delete agents. - aid: siemens:mindconnect-api name: Siemens MindConnect API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect/api-mindconnect-overview.html#mindconnect-api properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect/api-mindconnect-overview.html#mindconnect-api type: Documentation description: >- Send data from shop floor devices to the cloud. - aid: siemens:mindconnect-async-api name: Siemens MindConnect Async API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect-async/api-mindconnect-async-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect-async/api-mindconnect-async-overview.html type: Documentation description: >- Send data from shop floor devices to the cloud via MQTT. - aid: siemens:mindconnect-mqtt-api name: Siemens MindConnect MQTT API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect-mqtt/api-mindconnect-mqtt-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-mindconnect-mqtt/api-mindconnect-mqtt-overview.html type: Documentation description: >- Manage certificates for secure connection of the MQTT Agents. - aid: siemens:asset-modeler-async-api name: Siemens Asset Modeler Async API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-assetmodeler/api-assetmodeler-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-assetmodeler/api-assetmodeler-overview.html type: Documentation description: >- Manage Industrial IoT Assets in InsightsHub. - aid: siemens:opc-ua-pub-sub-service name: Siemens OPC UA Pub Sub Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-opcuapubsub/api-opcuapubsub-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-opcuapubsub/api-opcuapubsub-overview.html type: Documentation description: >- Upload Industrial IoT Data according to the OPC UA PubSub Specification. - aid: siemens:commanding-api name: Siemens Commanding API humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-commanding/api-commanding-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/connectivity-commanding/api-commanding-overview.html type: Documentation description: >- Execute commands on shopfloor devices. - aid: siemens:asset-management-service name: Siemens Asset Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-assetmanagement/api-assetmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-assetmanagement/api-assetmanagement-overview.html type: Documentation description: >- Create digital representation of your shopfloor devices. - aid: siemens:asset-management-subscription-notification name: Siemens Asset Management Subscription Notification humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-assetmanagement/api-assetmanagement-subscription-notification-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-assetmanagement/api-assetmanagement-subscription-notification-overview.html type: Documentation description: >- Notifications about changes in the asset model. - aid: siemens:event-management name: Siemens Event Management humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-eventmanagement/api-eventmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-eventmanagement/api-eventmanagement-overview.html type: Documentation description: >- The Event Management Service is used to capture events generated by devices in Insights Hub. - aid: siemens:event-management-subscription-notification name: Siemens Event Management Subscription Notification humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-eventmanagement/api-eventmanagement-subscription-notification-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-eventmanagement/api-eventmanagement-subscription-notification-overview.html type: Documentation description: >- Notification about changes in event objects. - aid: siemens:notification-service name: Siemens Notification Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-notification/api-notification-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-notification/api-notification-overview.html type: Documentation description: >- Send email, SMS or push notifications to consumers. - aid: siemens:case-management-management-service name: Siemens Case Management Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-casemanagement/api-casemanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-casemanagement/api-casemanagement-overview.html type: Documentation description: >- Basic digital workflow for work requests (maintenance, repair, inspection and incident handling). - aid: siemens:visual-flow-creator-service name: Siemens Visual Flow Creator Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-visual-flow-creator/api-visual-flow-creator-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-visual-flow-creator/api-visual-flow-creator-overview.html type: Documentation description: >- Visual data flow programming in Industrial IoT. - aid: siemens:rules-management-service name: Siemens Rules Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-rulesmanagement/api-rulesmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/advanced-rulesmanagement/api-rulesmanagement-overview.html type: Documentation description: >- Define Rules, triggers and actions on your digital assets. - aid: siemens:data-exchange-service name: Siemens Data Exchange Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-dataexchange/api-dataexchange-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-dataexchange/api-dataexchange-overview.html type: Documentation description: >- Upload and download data for any purpose. - aid: siemens:job-manager-service name: Siemens Job Manager Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-jobmanager/api-jobmanager-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-jobmanager/api-jobmanager-overview.html type: Documentation description: >- Essential functionalities for a data-driven analysis of event data. - aid: siemens:model-management-service name: Siemens Model Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-modelmanagement/api-modelmanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/analytics-modelmanagement/api-modelmanagement-overview.html type: Documentation description: >- Store single file models, algorithms, scripts docker images and training or validation data for ML or AI tasks. - aid: siemens:data-management-service name: Siemens Data Management Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/datamanagement/api-datamanagement-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/datamanagement/api-datamanagement-overview.html type: Documentation description: >- The Data Management related APIs handles the entire workflow of data registration and preparation for data contextualization. - aid: siemens:data-query-service name: Siemens Data Query Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/dataquery/api-dataquery-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/dataquery/api-dataquery-overview.html type: Documentation description: >- Query contextualized data in Insights Hub. - aid: siemens:semantic-modelling-service name: Siemens Semantic Modelling Service humanURL: >- https://developer.siemens.com/insights-hub/docs/apis/semantic-modelling/api-semanticmodel-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/apis/semantic-modelling/api-semanticmodel-overview.html type: Documentation description: >- End-to-end capability to import/create, update or delete entire ontological model. - aid: siemens:insights-hub-monitor-plugin-sdk name: Siemens Insights Hub Monitor Plugin SDK humanURL: >- https://developer.siemens.com/insights-hub/docs/resources/insights-hub-monitor-plugin-sdk/index.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/resources/insights-hub-monitor-plugin-sdk/index.html type: Documentation description: >- The Insights Hub Monitor Plugin SDK enables web developers to create plugins for Insights Hub Operations Insight. - aid: siemens:industrial-iot-sdk-v2-for-java name: Siemens Industrial IoT SDK V2 for Java humanURL: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-java/index.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-java/index.html type: Documentation description: >- Java clients for Industrial IoT APIs. - aid: siemens:industrial-iot-sdk-for-nodejs name: Siemens Industrial IoT SDK for Node.js humanURL: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-node/index.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-node/index.html type: Documentation description: >- Node.js clients for Industrial IoT APIs. - aid: siemens:industrial-iot-sdk-for-python name: Siemens Industrial IoT SDK for Python humanURL: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-python/index.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/resources/industrial-iot-sdk-python/index.html type: Documentation description: >- Python clients for Industrial IoT APIs. - aid: siemens:mindconnect-library-v4 name: Siemens MindConnect Library V4 humanURL: >- https://developer.siemens.com/insights-hub/docs/resources/mindconnect-lib-v4/resources-mclib-overview.html properties: - url: >- https://developer.siemens.com/insights-hub/docs/resources/mindconnect-lib-v4/resources-mclib-overview.html type: Documentation description: >- Connectivity Library written in C which allows a client application to exchange data with Siemens Industrial IoT Platform. - aid: siemens:user-experience-toolkit-for-insights-hub-and-industrial-iot name: Siemens User Experience Toolkit for Insights Hub and Industrial IOT humanURL: >- https://developer.siemens.com/../resources/design-systems/overview.html#user-experience-toolkit-for-insights-hub-and-industrial-iot properties: - url: >- https://developer.siemens.com/../resources/design-systems/overview.html#user-experience-toolkit-for-insights-hub-and-industrial-iot type: Documentation description: >- Design language for the overall look and feel of Insights Hub and Industrial IoT. - aid: siemens:mcenter-openness-apis-of-applications name: Siemens Mcenter - Openness APIs of Applications humanURL: https://developer.siemens.com/mcenter/overview.html properties: - url: https://developer.siemens.com/mcenter/overview.html type: Documentation description: >- Integrate with Mcenter applications for instrumenting CNC shop floor resource management tasks and accessing shop floor data via REST APIs and MQTT. - aid: siemens:nurse-call-system-api name: Siemens Nurse Call System API humanURL: https://developer.siemens.com/nurse-call-system/overview.html properties: - url: https://developer.siemens.com/nurse-call-system/overview.html type: Documentation description: >- Nurse Call System API let us integrate nurse call, color code call, restroom call data from Nurse call System to Ward Manager. - aid: siemens:ot-companion-asset-management-api name: Siemens OT Companion Asset Management API humanURL: https://developer.siemens.com/otc/asset-mgt-api/overview.html properties: - url: https://developer.siemens.com/otc/asset-mgt-api/overview.html type: Documentation description: >- OT Companion Asset Management API enables you to create and manage an asset for your Location. - aid: siemens:ot-companion-protection-settings-api name: Siemens OT Companion Protection Settings API humanURL: https://developer.siemens.com/otc/protection-setting-api/overview.html properties: - url: https://developer.siemens.com/otc/protection-setting-api/overview.html type: Documentation description: >- OT Companion Protection Settings API allows you to retrieve the assets with protection settings. - aid: siemens:plantsight-digital-enablement name: Siemens PlantSight Digital Enablement humanURL: >- https://developer.siemens.com/plantsight/plantsight-digital-enablement/index.html properties: - url: >- https://developer.siemens.com/plantsight/plantsight-digital-enablement/index.html type: Documentation description: >- APIs and services for project teams and owner-operators to create, visualize, and analyze the digital twin of their asset(s). - aid: siemens:comos-walkinside-service name: Siemens COMOS Walkinside Service humanURL: >- https://developer.siemens.com/plantsight/plantsight-immersive-simulation/index.html properties: - url: >- https://developer.siemens.com/plantsight/plantsight-immersive-simulation/index.html type: Documentation description: >- COMOS Walkinside Service enables the use of virtual reality to create a simulated environment and to provide trainings in a safe and controlled environment. - aid: siemens:undefined humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/parasolid/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/parasolid/" type: Documentation description: >- Develop applications in product design, manufacturing and analysis with Parasolid the leading 3D geometric modeling component, used in Siemens applications and licensed to 200 independent software vendors. - aid: siemens:undefined humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/d-cubed/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/d-cubed/" type: Documentation description: >- Enhance your CAD, CAM and CAE software applications with D-Cubed components for parametric sketching, assembly constraints, motion simulation, collision detection and hidden line drawing. - aid: siemens:undefined humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/kineo/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/kineo/" type: Documentation description: >- Optimize robotics simulation and digital mock-up in a wide range of industrial applications with Kineo components for automatic path planning, high-speed collision detection and predictive cable performance. - aid: siemens:geolus-shape-search name: Siemens Geolus Shape Search humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/geolus/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/geolus/" type: Documentation description: >- Find and reuse similar parts, no matter how they have been named, with Geolus Shape Search to enhance processes including design, procurement, part management and classification. - aid: siemens:3d-visualization-sdk name: Siemens 3D Visualization SDK humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/3d-visualization-sdk/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/3d-visualization-sdk/" type: Documentation description: >- Implement 3D visualization in your applications according to customer needs. Whether it's photorealistic rendering or engineering-oriented graphics with annotation, sectioning, and measurement, we have the 3D visualization SDK to meet your needs. - aid: siemens:simcenter-femap-oem name: Siemens Simcenter Femap OEM humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/simcenter/mechanical-simulation/femap/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/simcenter/mechanical-simulation/femap/" type: Documentation description: >- Create, edit and evaluate finite element models of complex products/systems using advanced CAE pre- and postprocessors to model components, assemblies or systems. - aid: siemens:solid-edge-oem name: Siemens Solid Edge OEM humanURL: >- https://developer.siemens.com/"https://solidedge.siemens.com/en/solutions/products/3d-design/solid-edge-oem/" properties: - url: >- https://developer.siemens.com/"https://solidedge.siemens.com/en/solutions/products/3d-design/solid-edge-oem/" type: Documentation description: >- Add value to your hardware and software solutions with our low-cost, easy-to-use computer-aided design (CAD) feature base customized with your brand look and feel. - aid: siemens:jt-open-toolkit-jttk name: Siemens JT Open Toolkit (JTTK) humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/jt/jt-open-toolkit/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/jt/jt-open-toolkit/" type: Documentation description: >- Access the rich content of JT data in your applications with the JT Open Toolkit, a C++ API for reading and writing ISO-compliant JT files. - aid: siemens:undefined humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/jt/jt2go/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/jt/jt2go/" type: Documentation description: >- View and interact with 3D data on your choice of desktop/mobile platform using JT2Go our free viewer for JT and Parasolid XT data. - aid: siemens:plm-xml name: Siemens PLM XML humanURL: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/kineo/" properties: - url: >- https://developer.siemens.com/"https://plm.sw.siemens.com/en-US/plm-components/kineo/" type: Documentation description: >- Represent rich product data explicitly and via references with PLM XML, a lightweight, flexible mechanism for transporting product data. - aid: siemens:polarion-rest-api name: Siemens Polarion REST API humanURL: https://developer.siemens.com/polarion/overview.html properties: - url: https://developer.siemens.com/polarion/overview.html type: Documentation description: >- Lets developers connect with Polarion via endpoints to integrate other tools in their toolchain, automate routine tasks, or create novel solutions tailored to a custom workflow. - aid: siemens:product-information-hub name: Siemens Product Information Hub humanURL: https://developer.siemens.com/product-information-api/overview.html properties: - url: https://developer.siemens.com/product-information-api/overview.html type: Documentation description: >- The Product Information Hub is offering comprehensive product data and lifecycle information for SIEMENS and other manufacturers through a unified, standardized interface. - aid: siemens:train-api name: Siemens Train API humanURL: https://developer.siemens.com/railigent-x/Train-API/index.html properties: - url: https://developer.siemens.com/railigent-x/Train-API/index.html type: Documentation description: >- The Railigent X Train API allows to retrieve real-time information about rolling stock assets of eligible fleets. Railigent X uses cloud technology to normalize asset information across multiple fleets to provide a unified access interface. - aid: siemens:railxplore-fusion-api name: Siemens RailXplore Fusion API humanURL: >- https://developer.siemens.com/railxplore-fusion/RailXplore-Fusion-API/index.html properties: - url: >- https://developer.siemens.com/railxplore-fusion/RailXplore-Fusion-API/index.html type: Documentation description: >- The APM RailXplore Fusion service API allows to retrieve real-time information about different types of asset information such as Events, Alarms, and Device information. - aid: siemens:ix-react-starter-app name: Siemens iX React Starter App humanURL: https://developer.siemens.com/undefined properties: - url: https://developer.siemens.com/undefined type: Documentation description: >- Web browser playground for iX react starter app. - aid: siemens:siemens-api-catalogue name: Siemens API Catalogue humanURL: >- https://developer.siemens.com/"https://www.postman.com/siemens-ag/workspace/siemens-xcelerator-developer-portal/overview" properties: - url: >- https://developer.siemens.com/"https://www.postman.com/siemens-ag/workspace/siemens-xcelerator-developer-portal/overview" type: Documentation description: >- Siemens API Catalogue is available on the Public API Network hosted by Postman. - aid: siemens:node-red-connectivity-playground name: Siemens Node-RED Connectivity Playground humanURL: https://developer.siemens.com/"https://playground.mindconnect.rocks" properties: - url: https://developer.siemens.com/"https://playground.mindconnect.rocks" type: Documentation description: >- Take a look at the live Node-RED flow examples which are sending the industrial OPC UA or MQTT Data to the cloud platform. - aid: siemens:industrial-edge-playground name: Siemens Industrial Edge Playground humanURL: >- https://developer.siemens.com/"https://www.siemens.com/global/en/products/automation/topic-areas/industrial-edge/developer/playground-registration.html" properties: - url: >- https://developer.siemens.com/"https://www.siemens.com/global/en/products/automation/topic-areas/industrial-edge/developer/playground-registration.html" type: Documentation description: >- Try out how Industrial Edge Management system, edge devices and edge apps work! - aid: siemens:carbon-footprint-indicator-for-transportation-api name: Siemens Carbon Footprint Indicator for Transportation API humanURL: https://developer.siemens.com/sdl/home.html properties: - url: https://developer.siemens.com/sdl/home.html type: Documentation description: >- The Carbon Footprint Indicator for Transportation web service generates a standard multi modal routing proposal and calculates transport emissions. - aid: siemens:siesmart-api name: Siemens SieSmart API humanURL: https://developer.siemens.com/siesmart/get-started/index.html properties: - url: https://developer.siemens.com/siesmart/get-started/index.html type: Documentation description: >- Create financing proposals for your customers straight from your platform. - aid: siemens:sigreen-procurement-api name: Siemens SiGREEN Procurement API humanURL: https://developer.siemens.com/sigreen/procurement-api/api-procurement.html properties: - url: >- https://developer.siemens.com/sigreen/procurement-api/api-procurement.html type: Documentation description: >- The Procurement API, part of SiGREENs suite of REST APIs, provides endpoints for managing components, suppliers, and component-level emissions within procurement processes for your company. - aid: siemens:sigreen-product-api name: Siemens SiGREEN Product API humanURL: https://developer.siemens.com/sigreen/product-api/api-product.html properties: - url: https://developer.siemens.com/sigreen/product-api/api-product.html type: Documentation description: >- The Product API, part of SiGREENs suite of REST APIs, provides endpoints for managing products and Bills of Materials (BOM) for your company. - aid: siemens:sigreen-mytask-api name: Siemens SiGREEN MyTask API humanURL: https://developer.siemens.com/sigreen/my-tasks-api/api-my-tasks.html properties: - url: https://developer.siemens.com/sigreen/my-tasks-api/api-my-tasks.html type: Documentation description: >- The MyTasks API, part of SiGREENs suite of REST APIs, provides endpoints for managing incoming and outgoing PCF requests for your company. - aid: siemens:sigreen-pcf-beta-api name: Siemens SiGREEN PCF (Beta) API humanURL: https://developer.siemens.com/sigreen/beta/api-beta.html properties: - url: https://developer.siemens.com/sigreen/beta/api-beta.html type: Documentation description: >- The PCF API, part of SiGREENs suite of REST APIs, provides endpoints for creating the Product Carbon Footprint (PCF) of your products on SiGREEN. - aid: siemens:simatic-ax-open-source name: Siemens SIMATIC AX Open Source humanURL: https://developer.siemens.com/"https://github.com/simatic-ax" properties: - url: https://developer.siemens.com/"https://github.com/simatic-ax" type: Documentation description: >- ST (Structured Text) examples, libraries, tutorials, code snippets and product templates for SIMATIC AX. - aid: siemens:sitrans-scm-iq-api name: Siemens SITRANS SCM IQ API humanURL: https://developer.siemens.com/sitrans-scm-iq/overview.html properties: - url: https://developer.siemens.com/sitrans-scm-iq/overview.html type: Documentation description: >- 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. - aid: siemens:teamcenter-x-product-cost-management-rest-api name: Siemens Teamcenter (X) Product Cost Management REST API humanURL: https://developer.siemens.com/tcpcm/overview.html properties: - url: https://developer.siemens.com/tcpcm/overview.html type: Documentation description: >- Calculation of product costs and carbon footprint. name: Siemens tags: - Automation - Electrification - Industry - Manufacturing - Building Automation - Industrial IoT - Smart Buildings - Digital Twin type: Contract image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg access: 3rd-Party created: '2024-11-08' modified: '2026-05-02' position: Consuming common: - type: Website url: https://www.siemens.com - type: Developer Portal url: https://developer.siemens.com/ - type: GitHub url: https://github.com/siemens - type: Documentation url: https://developer.siemens.com/ description: >- Siemens is a global powerhouse in the fields of electrification, automation and digitalization. The company offers a broad portfolio of products, solutions and services that enable customers to increase their efficiency and sustainability. Siemens operates in a variety of sectors including energy, healthcare, infrastructure, and industry. With a focus on innovation and technology, Siemens is constantly pushing the boundaries to create a better future for society and the environment. maintainers: - FN: Kin Lane email: kin@apievangelist.com specificationVersion: '0.19'